From b9b669570bbd4ad5fe273d61af055d02d19d4df9 Mon Sep 17 00:00:00 2001 From: Laura Hausmann Date: Fri, 24 Nov 2023 00:51:36 +0100 Subject: [PATCH] [docs] Add section on environment variables to install.md --- docs/install.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/install.md b/docs/install.md index 21be96547..0b05e6264 100644 --- a/docs/install.md +++ b/docs/install.md @@ -125,6 +125,13 @@ If this is your first run, after Iceshrimp has started successfully, you'll be a - Run `sudo systemctl enable --now iceshrimp` in order to enable and start Iceshrimp. - (Optional) Check if instance is running using `sudo systemctl status iceshrimp` +### Environment variables +- `ICESHRIMP_CONFIG` (default: `.config/default.yml`) to change where the the config file is located +- `ICESHRIMP_MEDIA_DIR` (default: `files`) to change where internally stored files are located +- `ICESHRIMP_CUSTOM_DIR` (default: `custom`) to change where custom assets and locales are located (caution: assets are copied at build time or when running `yarn gulp`, not during startup!) + +Make sure you are specifying absolute paths when setting environment variables. + ### Updating Iceshrimp Before you start, if you cloned the iceshrimp repository before the Git LFS migration, please follow [these instructions](https://iceshrimp.dev/iceshrimp/iceshrimp/wiki/Git-LFS#fixing-up-a-preexisting-cloned-repo) to get your repository back in sync.