diff --git a/README.md b/README.md index eaf309a4..d21638ab 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Fully featured and highly configurable SFTP server, written in Go - SSH user [certificate authentication](https://cvsweb.openbsd.org/src/usr.bin/ssh/PROTOCOL.certkeys?rev=1.8). - Keyboard interactive authentication. You can easily setup a customizable multi-factor authentication. - Partial authentication. You can configure multi-step authentication requiring, for example, the user password after successful public key authentication. -- Per user authentication methods. You can, for example, deny one or more authentication methods to one or more users. +- Per user authentication methods. You can configure the allowed authentication methods for each user. - Custom authentication via external programs/HTTP API is supported. - Dynamic user modification before login via external programs/HTTP API is supported. - Quota support: accounts can have individual quota expressed as max total size and/or max number of files. @@ -54,7 +54,7 @@ The test cases are regularly manually executed and passed on Windows. Other UNIX Binary releases for Linux, macOS, and Windows are available. Please visit the [releases](https://github.com/drakkan/sftpgo/releases "releases") page. -Sample Dockerfiles for [Debian](https://www.debian.org "Debian") and [Alpine](https://alpinelinux.org "Alpine") are available inside the source tree [docker](./docker "docker") directory. +Sample Dockerfiles for [Debian](https://www.debian.org) and [Alpine](https://alpinelinux.org) are available inside the source tree [docker](./docker) directory. Some Linux distro packages are available: @@ -128,7 +128,7 @@ A user can be created or modified by an external program just before the login. ## Custom Actions -SFTPGo allows you to configure custom commands and/or HTTP notifications on file upload, download, delete, rename, on SSH commands and on user add, update and delete. +SFTPGo allows to configure custom commands and/or HTTP notifications on file upload, download, delete, rename, on SSH commands and on user add, update and delete. More information about custom actions can be found [here](./docs/custom-actions.md). diff --git a/docker/sftpgo/alpine/README.md b/docker/sftpgo/alpine/README.md index 2a955ce9..859c2035 100644 --- a/docker/sftpgo/alpine/README.md +++ b/docker/sftpgo/alpine/README.md @@ -15,8 +15,7 @@ sudo groupadd -g 1003 sftpgrp && \ # Get and build SFTPGo image. # Add --build-arg TAG=LATEST to build the latest tag or e.g. TAG=0.9.6 for a specific tag/commit. -# Add --build-arg FEATURES= to disable some feature. -# Please 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. +# Add --build-arg FEATURES= to specify the feature to build. git clone https://github.com/drakkan/sftpgo.git && \ cd sftpgo && \ sudo docker build -t sftpgo docker/sftpgo/alpine/ diff --git a/docker/sftpgo/debian/README.md b/docker/sftpgo/debian/README.md index 7ea154b6..e16e6f8e 100644 --- a/docker/sftpgo/debian/README.md +++ b/docker/sftpgo/debian/README.md @@ -16,10 +16,10 @@ To build the latest tag you can add `--build-arg TAG=LATEST` and to build a spec docker build -t="drakkan/sftpgo" --build-arg TAG=0.9.6 . ``` -To disable some features you can add `--build-arg FEATURES=`. For example you can disable SQLite support like this: +To specify the features to build you can add `--build-arg FEATURES=`. For example you can disable SQLite and S3 support like this: ```bash -docker build -t="drakkan/sftpgo" --build-arg FEATURES=nosqlite . +docker build -t="drakkan/sftpgo" --build-arg FEATURES=nosqlite,nos3 . ``` Please 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. diff --git a/docs/build-from-source.md b/docs/build-from-source.md index 6e2a46d7..dd7e1e66 100644 --- a/docs/build-from-source.md +++ b/docs/build-from-source.md @@ -8,17 +8,17 @@ go get -u github.com/drakkan/sftpgo Make sure [Git](https://git-scm.com/downloads) is installed on your machine and in your system's `PATH`. -The following build tags are available to disable some features: +The following build tags are available: -- `nogcs`, disable Google Cloud Storage backend -- `nos3`, disable S3 Compabible Object Storage backends -- `nobolt`, disable Bolt data provider -- `nomysql`, disable MySQL data provider -- `nopgsql`, disable PostgreSQL data provider -- `nosqlite`, disable SQLite data provider -- `noportable`, disable portable mode +- `nogcs`, disable Google Cloud Storage backend, default enabled +- `nos3`, disable S3 Compabible Object Storage backends, , default enabled +- `nobolt`, disable Bolt data provider, , default enabled +- `nomysql`, disable MySQL data provider, default enabled +- `nopgsql`, disable PostgreSQL data provider, default enabled +- `nosqlite`, disable SQLite data provider, default enabled +- `noportable`, disable portable mode, default enabled -If no build tag is specified all the features will be included. +If no build tag is specified the build will include the default features. The optional [SQLite driver](https://github.com/mattn/go-sqlite3 "go-sqlite3") is a `CGO` package and so it requires a `C` compiler at build time. On Linux and macOS, a compiler is easy to install or already installed. On Windows, you need to download [MinGW-w64](https://sourceforge.net/projects/mingw-w64/files/) and build SFTPGo from its command prompt.