documentation

Author: metame

README.md

@@ -51,6 +51,7 @@ https://user-images.githubusercontent.com/2183313/139728539-d69b899f-6f9b-44cb-a
 
 Check out the [documentation](http://docs.atomicdata.dev/atomicserver/intro.html) for installation instructions, API docs, and more.
 
+### Configuring S3 for File Storage
 ## Contribute
 
 Issues and PRs are welcome!

docs/src/atomicserver/installation.md

@@ -106,6 +106,20 @@ ATOMIC_HTTPS=false
 ATOMIC_SERVER_URL=https://example.com
 ```
 
+### Configuring S3 for File Storage
+You can configure atomic-server to use S3 (and compatible services) for file storage via environment variables or command line arguments when starting atomic-server.
+
+Credentials can either be found in the standard location for AWS credentials on your OS (e.g. `~/.aws/credentials` on UNIX systems) or by using the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
+
+Available configuration values:
+
+- bucket: `--s3-bucket="my-bucket-name"` or env var `ATOMIC_S3_BUCKET` (required)
+- region: `--s3-region="us-east-2"` or env var `ATOMIC_S3_REGION`
+- endpoint: `--s3-endpoint="https://s3.us-east-2.amazonaws.com"` or env var `ATOMIC_S3_ENDPOINT`
+0 path: `--s3-path="atomic_uploads"` or env var `ATOMIC_S3_PATH`
+
+For example, the above configuration would uploads files to `s3://my-bucket-name/atomic_uploads/` in the `us-east-2` region.
+
 ## Using `systemd` to run Atomic-Server as a service
 
 In Linux operating systems, you can use `systemd` to manage running processes.