improve some docs

This commit is contained in:
Nicola Murino 2021-12-26 14:54:29 +01:00
parent 59bb578b89
commit c36217c654
No known key found for this signature in database
GPG key ID: 2F1FB59433D5A8CB
7 changed files with 9 additions and 9 deletions

View file

@ -10,7 +10,7 @@ $ curl "http://admin:password@127.0.0.1:8080/api/v2/token"
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiQVBJIl0sImV4cCI6MTYxMzMzNTI2MSwianRpIjoiYzBrb2gxZmNkcnBjaHNzMGZwZmciLCJuYmYiOjE2MTMzMzQ2MzEsInBlcm1pc3Npb25zIjpbIioiXSwic3ViIjoiYUJ0SHUwMHNBUmxzZ29yeEtLQ1pZZWVqSTRKVTlXbThHSGNiVWtWVmc1TT0iLCJ1c2VybmFtZSI6ImFkbWluIn0.WiyqvUF-92zCr--y4Q_sxn-tPnISFzGZd_exsG-K7ME" "http://127.0.0.1:8080/api/v2/dumpdata?output-data=1" curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiQVBJIl0sImV4cCI6MTYxMzMzNTI2MSwianRpIjoiYzBrb2gxZmNkcnBjaHNzMGZwZmciLCJuYmYiOjE2MTMzMzQ2MzEsInBlcm1pc3Npb25zIjpbIioiXSwic3ViIjoiYUJ0SHUwMHNBUmxzZ29yeEtLQ1pZZWVqSTRKVTlXbThHSGNiVWtWVmc1TT0iLCJ1c2VybmFtZSI6ImFkbWluIn0.WiyqvUF-92zCr--y4Q_sxn-tPnISFzGZd_exsG-K7ME" "http://127.0.0.1:8080/api/v2/dumpdata?output-data=1"
``` ```
the dump is a JSON with users, folder and admins. the dump is a JSON with all SFTPGo data including users, folders, admins.
These properties are stored inside the configured data provider. These properties are stored inside the configured data provider.

View file

@ -17,4 +17,4 @@ For multipart uploads you can customize the parts size and the upload concurrenc
The configured container must exist. The configured container must exist.
This backend is very similar to the [S3](./s3.md) backend, and it has the same limitations. This backend is very similar to the [S3](./s3.md) backend, and it has the same limitations. As with S3 `chtime` will fail with the default configuration, you can install the [metadata plugin](https://github.com/sftpgo/sftpgo-plugin-metadata) to make it work and thus be able to preserve/change file modification times.

View file

@ -13,9 +13,6 @@ The following build tags are available:
- `nosqlite`, disable SQLite data provider, default enabled - `nosqlite`, disable SQLite data provider, default enabled
- `noportable`, disable portable mode, default enabled - `noportable`, disable portable mode, default enabled
- `nometrics`, disable Prometheus metrics, default enabled - `nometrics`, disable Prometheus metrics, default enabled
- `novaultkms`, disable Vault transit secret engine, default enabled
- `noawskms`, disable AWS KMS, default enabled
- `nogcpkms`, disable GCP KMS, default enabled
If no build tag is specified the build will include the default features. If no build tag is specified the build will include the default features.

View file

@ -8,4 +8,4 @@ You can optionally specify a [storage class](https://cloud.google.com/storage/do
The configured bucket must exist. The configured bucket must exist.
This backend is very similar to the [S3](./s3.md) backend, and it has the same limitations. This backend is very similar to the [S3](./s3.md) backend, and it has the same limitations. As with S3 `chtime` will fail with the default configuration, you can install the [metadata plugin](https://github.com/sftpgo/sftpgo-plugin-metadata) to make it work and thus be able to preserve/change file modification times.

View file

@ -20,7 +20,7 @@ The configured bucket must exist.
Some SFTP commands don't work over S3: Some SFTP commands don't work over S3:
- `chtimes`, `chown` and `chmod` will fail. If you want to silently ignore these method set `setstat_mode` to `1` or `2` in your configuration file - `chown` and `chmod` will fail. If you want to silently ignore these method set `setstat_mode` to `1` or `2` in your configuration file
- `truncate`, `symlink`, `readlink` are not supported - `truncate`, `symlink`, `readlink` are not supported
- opening a file for both reading and writing at the same time is not supported - opening a file for both reading and writing at the same time is not supported
- resuming uploads is not supported - resuming uploads is not supported
@ -33,3 +33,4 @@ Other notes:
- For server side encryption, you have to configure the mapped bucket to automatically encrypt objects. - For server side encryption, you have to configure the mapped bucket to automatically encrypt objects.
- A local home directory is still required to store temporary files. - A local home directory is still required to store temporary files.
- Clients that require advanced filesystem-like features such as `sshfs` are not supported. - Clients that require advanced filesystem-like features such as `sshfs` are not supported.
- `chtime` will fail with the default configuration, you can install the [metadata plugin](https://github.com/sftpgo/sftpgo-plugin-metadata) to make it work and thus be able to preserve/change file modification times.

View file

@ -46,7 +46,7 @@ sudo sh -c 'echo "SFTPGO_DATA_PROVIDER__CREDENTIALS_PATH=/var/lib/sftpgo/credent
# also set the provider's PATH as env var to get initprovider to work with SQLite provider: # also set the provider's PATH as env var to get initprovider to work with SQLite provider:
#export SFTPGO_DATA_PROVIDER__NAME=/var/lib/sftpgo/sftpgo.db #export SFTPGO_DATA_PROVIDER__NAME=/var/lib/sftpgo/sftpgo.db
# install static files and templates for the web UI # install static files and templates for the web UI
sudo cp -r static templates /usr/share/sftpgo/ sudo cp -r static templates openapi /usr/share/sftpgo/
# set files and directory permissions # set files and directory permissions
sudo chown -R sftpgo:sftpgo /etc/sftpgo /var/lib/sftpgo sudo chown -R sftpgo:sftpgo /etc/sftpgo /var/lib/sftpgo
sudo chmod 750 /etc/sftpgo /var/lib/sftpgo sudo chmod 750 /etc/sftpgo /var/lib/sftpgo
@ -91,7 +91,7 @@ sudo chown root:wheel /usr/local/opt/sftpgo/init/com.github.drakkan.sftpgo.plist
# install the default configuration file, edit it if required # install the default configuration file, edit it if required
sudo cp sftpgo.json /usr/local/opt/sftpgo/etc/ sudo cp sftpgo.json /usr/local/opt/sftpgo/etc/
# install static files and templates for the web UI # install static files and templates for the web UI
sudo cp -r static templates /usr/local/opt/sftpgo/usr/share/ sudo cp -r static templates openapi /usr/local/opt/sftpgo/usr/share/
# initialize the configured data provider # initialize the configured data provider
# if you want to use MySQL or PostgreSQL you need to create the configured database before running the initprovider command # if you want to use MySQL or PostgreSQL you need to create the configured database before running the initprovider command
sudo /usr/local/opt/sftpgo/bin/sftpgo initprovider -c /usr/local/opt/sftpgo/etc/ sudo /usr/local/opt/sftpgo/bin/sftpgo initprovider -c /usr/local/opt/sftpgo/etc/

View file

@ -14,6 +14,8 @@
<string>/usr/local/opt/sftpgo/usr/share/templates</string> <string>/usr/local/opt/sftpgo/usr/share/templates</string>
<key>SFTPGO_HTTPD__STATIC_FILES_PATH</key> <key>SFTPGO_HTTPD__STATIC_FILES_PATH</key>
<string>/usr/local/opt/sftpgo/usr/share/static</string> <string>/usr/local/opt/sftpgo/usr/share/static</string>
<key>SFTPGO_HTTPD__OPENAPI_PATH</key>
<string>/usr/local/opt/sftpgo/usr/share/openapi</string>
<key>SFTPGO_HTTPD__BACKUPS_PATH</key> <key>SFTPGO_HTTPD__BACKUPS_PATH</key>
<string>/usr/local/opt/sftpgo/var/lib/backups</string> <string>/usr/local/opt/sftpgo/var/lib/backups</string>
<key>SFTPGO_DATA_PROVIDER__CREDENTIALS_PATH</key> <key>SFTPGO_DATA_PROVIDER__CREDENTIALS_PATH</key>