diff --git a/README.md b/README.md index 2af8c02..66e02d4 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,9 @@ File Browser -e ARIA2_USER=user \ -e ARIA2_PWD=password \ -e ARIA2_EXTERNAL_PORT=443 \ + -e CADDY_LOG_LEVEL=ERROR \ -v /yourdata:/data \ + -v /app/.cache:/app/.cache \ -v /app/a.db:/app/filebrowser.db \ -v /to_yoursslkeys/:/app/conf/key \ -v :/app/conf \ @@ -115,30 +117,34 @@ services: Then simply run `docker-compose up -d`, that's it! ### Supported Environment Variables - - * `ENABLE_AUTH` whether to enable Basic auth - * `ENABLE_RCLONE` whether to disable Rclone, if you running this container offline or do not have stable connection to Github, please set to `false` - * `ARIA2_USER` Basic Auth username, Rclone GUI uses it as well. - * `ARIA2_PWD` Basic Auth password, Rclone GUI uses it as well. - * `ARIA2_EXTERNAL_PORT` The Aria2 port which exposed to public to access to - * `PUID` Bind Linux UID into container which means you can use non `root` user to manage downloaded files, default UID is `1000` - * `PGID` Bind Linux GID into container, default GID is 1000 - * `RPC_SECRET` The Aria2 RPC secret token - * `DOMAIN` The domain you'd like to bind, when domain is a `https://` thing, then auto TLS feature will be enabled - * `RCLONE_CONFIG_BASE64` Inject and config Rclone through `base64` string, which is the only way to use Rclone on Heroku. Please use `cat /app/conf/rclone.conf | base64` or any base64 online tools such as [this](https://www.base64encode.org/) to encode your `rclone.conf` as bse64 string. Note, you need to set `ENABLE_RCLONE` to true as well. - * `ENABLE_APP_CHECKER`, by default it's set to `true` to check if any new docker image version release on daily basis, which can help you get notification when new features released as well as some security vulnerabilities get fixed. You can set it to `false` to disable this feature. Note: you still need to manually pull the new image version and re run the docker container to complete upgrading. +| ENV | Description| +|:---|:---| +| `ENABLE_AUTH` | Whether to enable Basic auth | +| `ENABLE_RCLONE` | Whether to disable Rclone, if you running this container offline or do not have stable connection to Github, please set to `false` +| `ARIA2_USER` | Basic Auth username, Rclone GUI uses it as well. | +| `ARIA2_PWD` | Basic Auth password, Rclone GUI uses it as well. | +| `ARIA2_EXTERNAL_PORT` | The Aria2 port which exposed to public to access to | +| `PUID` | Bind Linux UID into container which means you can use non `root` user to manage downloaded files, default UID is `1000` | +| `PGID` | Bind Linux GID into container, default GID is 1000 | +| `RPC_SECRET` | The Aria2 RPC secret token | +| `DOMAIN` | The domain you'd like to bind, when domain is a `https://` thing, then auto TLS feature will be enabled | +| `RCLONE_CONFIG_BASE64` | Inject and config Rclone through `base64` string, which is the only way to use Rclone on Heroku. Please use `cat /app/conf/rclone.conf \| base64` or any base64 online tools such as [this](https://www.base64encode.org/) to encode your `rclone.conf` as bse64 string. Note, you need to set `ENABLE_RCLONE` to true as well. | +| `ENABLE_APP_CHECKER` | By default it's set to `true` to check if any new docker image version release on daily basis, which can help you get notification when new features released as well as some security vulnerabilities get fixed. You can set it to `false` to disable this feature. Note: you still need to manually pull the new image version and re run the docker container to complete upgrading. | +| CADDY_LOG_LEVEL | For specifying the log level of Caddy, set it to `ERROR` to reduce logs. Default: `INFO` | ### Supported Volumes - * `/data` The folder contains all the files you download. - * `/app/conf/key` The folder which stores Aria2 SSL `certificate` and `key` file. `Notice`: The certificate file should be named `aria2.crt` and the key file should be named `aria2.key` - * `/app/conf` The Aria2 configuration and file session folder. Make sure you have `aria2.conf` and `aria2.session` file. For the first time `aria2.session` just need to be a empty file can be appended. You can also user the templates for these two file in the `conf` folder of this project. Please put your `rclone.conf` in this folder as well if you'd mount it to Rclone. So all the config files supported in this folder are: - * aria2.conf - * aria2.session - * rclone.conf - **Warning: if you don't mount `/app/conf`, whenever the container restarts, you'll lose your downloading progress.** - * `/app/filebrowser.db` File Browser settings database, make sure you make a empty file first on your host. +| Mountable folder | Description| +|:---|:---| +| `/data` | The folder contains all the files you download. | +| `/app/conf/key` | The folder which stores Aria2 SSL `certificate` and `key` |file. `Notice`: The certificate file should be named `aria2.crt` and the key file should be named `aria2.key` | +| `/app/conf` | The Aria2 configuration and file session folder. Make sure you have `aria2.conf` and `aria2.session` file. For the first time `aria2.session` just need to be a empty file can be appended. You can also user the templates for these two file in the `conf` folder of this project. Please put your `rclone.conf` in this folder as well if you'd mount it to Rclone. So all the config files supported in this folder are: `aria2.conf`, `aria2.session`, `rclone.conf`. 🚨Warning🚨: if you don't mount `/app/conf`, whenever the container restarts, you'll lose your downloading progress. | +|`/app/conf/aria2.conf` | See description above👆🏼 | +|`/app/conf/aria2.session` | See description above👆🏼 | +|`/app/conf/rclone.conf` | See description above👆🏼 | +| `/app/filebrowser.db` | File Browser settings database, make sure you make a empty file first on your host. | +| `/app/.cache` | The folder for storing rclone caches and [aria2 DHT files](https://aria2.github.io/manual/en/html/aria2c.html#cmdoption-dht-file-path) | ## Auto HTTPS enabling