Configuration¶
Each Strawly instance is configured by one file, .env, in its instance folder: /opt/strawly/instances/<name>/.env on a server, ~/strawly/instances/<name>/.env on your own computer. The installer writes it. You rarely need to edit it by hand, because the strawly command changes the common settings for you.
Common changes¶
| Change | Command |
|---|---|
| Turn the Azure module on or off | strawly enable-module optimizations-azure / strawly disable-module optimizations-azure |
| Move the instance to another port | strawly set-port 9000 |
| Move from a local network address to a domain with HTTPS | strawly add-domain strawly.example.com you@example.com |
| Change versions | strawly upgrade (see Updating) |
Editing .env by hand¶
After an edit, apply it with:
The settings you are most likely to change:
| Variable | What it controls |
|---|---|
COMPOSE_PROFILES |
Which modules run. azure runs the Azure module, none runs no modules. Separate several with commas. |
STRAWLY_MODE |
local, lan or domain. See Deploy on a server. |
STRAWLY_PUBLIC_URL |
The address people type in the browser. Strawly accepts browser requests only from this address. |
STRAWLY_HTTP_PORT |
The port of this instance on the server. Every instance on a machine needs its own. |
STRAWLY_BIND |
127.0.0.1 keeps the port on the machine itself. 0.0.0.0 opens it to the network (LAN mode). |
Environment Variables lists every variable.
Module settings¶
Schedules, thresholds and other module options are not in .env. Change them in Strawly under Settings > Modules. A module creates its default settings the first time it starts, and later starts never overwrite your changes.
Ports¶
Each instance opens one port on the machine: STRAWLY_HTTP_PORT, which serves both the web interface and the API. The frontend, backend, modules and database talk to each other on the instance's private Docker network and open no ports on the machine, so they never clash with other software or with other instances.
The installer suggests the first free port from 8080 and lets you choose another, or takes one with --port. A port counts as taken when another Strawly instance uses it, even a stopped one, or when any program listens on it. Ports 80 and 443 are kept for the HTTPS edge proxy in domain mode.
To change the port later, run strawly set-port <port>. In local and LAN mode the address you open in the browser changes with it. In domain mode the address stays https://<your-domain>.