diff --git a/Readme.md b/Readme.md index 001b7b4b1..127410482 100644 --- a/Readme.md +++ b/Readme.md @@ -27,7 +27,7 @@ deploy ## Container configuration ### Environment variables -- *SOPS_AGE_KEY* +- **SOPS_AGE_KEY** The files `fdroid/config.yml` and `fdroid/keystore.p12` are encrypted with `sops`. The update script automatically decrypts them on the first start of the container. @@ -35,11 +35,12 @@ For this to work the environment variable `SOPS_AGE_KEY` must be set to the age This key can be generated by running `age-keygen -o key.txt`. ### External volumes -- */apks* +- **/apks** The update script downloads new apk versions into the `/apks` directory. The apks in there are synced on each update run to the `/src/code/fdroid/repo` directory, where they are served from. Therefore, the `/apks` directory is the perfect place to mount an external volume to persist all apks and avoid re-downloading on container restart. +This also allows manually placing apks to be served into this directory. ## Apk update scripts To automatically pull new versions of an apk, create a bash script in the `scripts/apk-update-scripts` directory.