stashapp/Stash-Docs
1
0
Fork 0
mirror of https://github.com/stashapp/Stash-Docs.git synced 2026-04-12 23:37:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Simplify the advanced configuration options guide

Browse Source
This commit is contained in:
DogmaDragon
2026-02-13 18:41:17 +02:00
parent 117f91396a
commit 2f746b60de
1 changed files with 101 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
docs/guides/advanced-configuration-options.md
View File

@@ -1,27 +1,109 @@
---
title: Advanced configuration options
hide:
- toc
---
Some configuration options can not be edited through the UI and should only be used if needed.
Some configuration options cannot be edited through the UI and should only be changed if necessary.
Depending on the option they can be configured either by editing the `config.yml` configuration file or by using an enviroment variable or in a few cases by using flags when running stash.
Depending on the option, configuration can be done in one of three ways:
As an example the `port` option can be changed from the default `9999` to `1234` by one of the below methods:
- By editing the `config.yml` configuration file
- By setting an environment variable
- By using a command-line flag when running Stash
- adding `port: 1234` to the config.yml file
- setting the ENV variable **STASH_PORT** to **1234** eg `STASH_PORT=1234 ./stash`
- using the flag **--port** when running stash `./stash --port 1234`
For example, to change the `port` option from the default `9999` to `1234`, you can use any of the following methods:
Configuration Option | YML | ENV | FLAG | Description | Comments
---------------------|:---:|:---:|:----:|-------------|:-------------:
host|host|STASH_HOST|--host| The ip address for the host that stash is listening to | default: 0.0.0.0
port|port|STASH_PORT|--port| The port that stash serves to |default: 9999
external host|external_host|STASH_EXTERNAL_HOST|-| Needed in some cases when you use a reverse proxy | [Docs](/guides/reverse-proxy/)
plugins path|plugins_path|-|-|The path to the stash plugins folder|Only use if you need to override the default
scrapers path|scrapers_path|-|-|The path to the scrapers folder|Only use if you need to override the default
custom served folders|custom_served_folders|-|-|Allows configuration of mapped URLs to file system folders|[PR](https://github.com/stashapp/stash/pull/620){:target="_blank"}
maximum upload size|max_upload_size|-|-|Change the maximum size (in MB) for partial imports| default: 1024 (1GB)
proxy|proxy|-|-| The url of a HTTP(S) proxy to be used when stash makes calls to online services | Example: https://user:password@my.proxy:8080
no proxy|no_proxy|-|-| A list of domains for which the proxy must not be used | default is all local LAN: localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12
- Add `port: 1234` to the `config.yml` file
- Set the environment variable `STASH_PORT=1234` before running Stash (e.g., `STASH_PORT=1234 ./stash`)
- Use the command-line flag when running Stash (e.g., `./stash --port 1234`)
## Configuration options
### host
The IP address for the host that stash is listening to. Default is `0.0.0.0`.
| Key | Value |
|------------|--------------|
| **Configuration file** | `host` |
| **Environment variable** | `STASH_HOST` |
| **Command-line interface flag** | `--host` |
### port
The port that Stash serves to. Default is `9999`.
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `port` |
| **Environment variable** | `STASH_PORT` |
| **Command-line interface flag** | `--port` |
### external host
Needed in some cases when you use a reverse proxy. See [reverse proxy guide](/guides/reverse-proxy/) for more details.
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `external_host` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### plugins path
The path to the stash plugins folder. **Only use if you need to override the default.**
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `plugins_path` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### scrapers path
The path to the scrapers folder. **Only use if you need to override the default.**
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `scrapers_path` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### custom served folders
Allows configuration of mapped URLs to file system folders. See [pull request](https://github.com/stashapp/stash/pull/620){:target="_blank"} for more details.
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `custom_served_folders` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### maximum upload size
Change the maximum size (in MB) for partial imports. Default is `1024 (1GB)`.
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `max_upload_size` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### proxy
The URL of a HTTP(S) proxy to be used when stash makes calls to online services. _Example: `https://user:password@my.proxy:8080`_
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `proxy` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |
### no proxy
A list of domains for which the proxy must not be used. Default is all local LAN `localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12_`
| Key | Value |
|----------------------------|--------------|
| **Configuration file** | `no_proxy` |
| **Environment variable** | _(none)_ |
| **Command-line interface flag** | _(none)_ |