1# Dockerfile based on Debian stable
2
3:warning: The recommended way to run SFTPGo on Docker is to use the official [images](https://hub.docker.com/r/drakkan/sftpgo). The documentation here is now obsolete.
4
5Please read the comments inside the `Dockerfile` to learn how to customize things for your setup.
6
7You can build the container image using `docker build`, for example:
8
9```bash
10docker build -t="drakkan/sftpgo" .
11```
12
13This will build master of github.com/drakkan/sftpgo.
14
15To build the latest tag you can add `--build-arg TAG=LATEST` and to build a specific tag/commit you can use for example `TAG=v1.0.0`, like this:
16
17```bash
18docker build -t="drakkan/sftpgo" --build-arg TAG=v1.0.0 .
19```
20
21To specify the features to build you can add `--build-arg FEATURES=<build features comma separated>`. For example you can disable SQLite and S3 support like this:
22
23```bash
24docker build -t="drakkan/sftpgo" --build-arg FEATURES=nosqlite,nos3 .
25```
26
27Please take a look at the [build from source](./../../../docs/build-from-source.md) documentation for the complete list of the features that can be disabled.
28
29Now create the required folders on the host system, for example:
30
31```bash
32sudo mkdir -p /srv/sftpgo/data /srv/sftpgo/config /srv/sftpgo/backups
33```
34
35and give write access to them to the UID/GID defined inside the `Dockerfile`. You can choose to create a new user, on the host system, with a matching UID/GID pair, or simply do something like this:
36
37```bash
38sudo chown -R <UID>:<GID> /srv/sftpgo/data /srv/sftpgo/config /srv/sftpgo/backups
39```
40
41Download the default configuration file and edit it as you need:
42
43```bash
44sudo curl https://raw.githubusercontent.com/drakkan/sftpgo/master/sftpgo.json -o /srv/sftpgo/config/sftpgo.json
45```
46
47Initialize the configured provider. For PostgreSQL and MySQL providers you need to create the configured database and the `initprovider` command will create the required tables:
48
49```bash
50docker run --name sftpgo --mount type=bind,source=/srv/sftpgo/config,target=/app/config drakkan/sftpgo initprovider -c /app/config
51```
52
53and finally you can run the image using something like this:
54
55```bash
56docker rm sftpgo && docker run --name sftpgo -p 8080:8080 -p 2022:2022 --mount type=bind,source=/srv/sftpgo/data,target=/app/data --mount type=bind,source=/srv/sftpgo/config,target=/app/config --mount type=bind,source=/srv/sftpgo/backups,target=/app/backups drakkan/sftpgo
57```
58
59If you want to enable FTP/S you also need the publish the FTP port and the FTP passive port range, defined in your `Dockerfile`, by adding, for example, the following options to the `docker run` command `-p 2121:2121 -p 50000-50100:50000-50100`. The same goes for WebDAV, you need to publish the configured port.
60