Configuration

OpenConnect is configured in two places: environment variables in .env (next to docker-compose.yml), and the Settings page in the browser. Restart with docker compose up -d after changing .env.

Environment Variables

Variable	Default	What it does
ASC_KEY_ID		API key ID. Can be set in Settings instead.
ASC_ISSUER_ID		API issuer ID. Can be set in Settings instead.
ASC_VENDOR_NUMBER		Vendor number for sales and subscription reports. Can be set in Settings instead.
ASC_PRIVATE_KEY_PATH	found automatically	Path to the .p8 file as the app sees it (inside the container). Only needed when the key isn't named AuthKey_<KEY_ID>.p8 in the keys folder. Can be set in Settings instead.
ASC_PRIVATE_KEY		The contents of the .p8 file, as an alternative to a file. \n in the value is read as a line break.
ASC_KEYS_DIR_HOST	./keys	The folder on your computer that holds the .p8. It's mounted read-only.
OPENCONNECT_VERSION	latest	Which published image to run, for example 1.2.0. Ignored with --build.
PORT	3000	Port on your computer.
BIND_ADDRESS	127.0.0.1	127.0.0.1 means only this computer can connect. 0.0.0.0 lets your whole network connect.
OPENCONNECT_PASSWORD_REQUIRED	true	false turns the password off completely. See Running Without a Password.
OPENCONNECT_PASSWORD		Sets the password here instead of choosing it in the browser.
OPENCONNECT_PASSWORD_FILE		Reads the password from a file, such as a Docker secret.
OPENCONNECT_ALLOWED_HOSTS		Only used with the password off: extra hostnames you open the dashboard by, comma-separated.
TS_AUTHKEY, TS_HOSTNAME	TS_HOSTNAME=openconnect	For HTTPS with Tailscale.

These are set inside the container by docker-compose.yml, and you only need them when running without Docker:

Variable	Default	What it does
DATA_DIR	./data (/app/data in Docker)	Where the database lives.
ASC_KEYS_DIR	/keys in Docker	A folder searched for AuthKey_<KEY_ID>.p8.
APPSHOT_DATA	/app/data/studio in Docker	The screenshot studio's data folder.
OPENCONNECT_STUDIO_URL	http://studio:4317 in Docker	Where the studio's renderer runs.
DISABLE_SCHEDULER		1 turns off automatic syncs.

Where the Key Comes From

Environment variables win over Settings. A field set in .env shows a from environment badge in Settings and can't be edited there.

For the private key, OpenConnect uses the first of these that's set:

1. The key contents, from ASC_PRIVATE_KEY or pasted in Settings.
2. The file at ASC_PRIVATE_KEY_PATH, or the path in Settings.
3. A file named AuthKey_<KEY_ID>.p8 in one of these folders: ASC_KEYS_DIR, /keys, keys/ in the app's folder, or ~/.appstoreconnect/private_keys.

Settings

Open Settings with the gear button at the top right of the dashboard. It has six sections.

General

• Appearance: System, Light or Dark. New installs start in dark mode.
• Dashboard defaults: the Date range and Currency the dashboard opens with, and Compare with the previous period, which shows ▲ and ▼ changes on key metrics.

Customize

Which apps, sections, metrics and columns appear, and where. See Customization.

App Store Connect

Vendor number, Key ID, Issuer ID, Private key (.p8) path, and …or paste the .p8 contents. Click Save, or Save & test connection to check that Apps, Reviews and Sales reports work with the key. A pasted key is stored in the database and is never sent back to the browser; Settings only shows key stored.

Sync

Setting	Default	Options
Sales & analytics	Every 6 hours	Off (manual only), every 1, 3, 6, 12 or 24 hours
Ratings & rankings	Every 24 hours	Off (manual only), every 6, 12, 24 or 48 hours, weekly
Subscription reports	On	Active subscriptions and subscription events.
Impressions & product page views	On	Apple's analytics reports.
Customer reviews	On
Charts to check for rankings	Top Free and Top Grossing	Top Free, Top Paid, Top Grossing. Fewer charts make the check faster.
Also check overall (all-category) charts	On	Besides each app's own category.

See Syncing.

Security

Change the password, sign out, sign out everywhere, and manage API tokens. See Security.

About

The version you're running, where your data lives, and what leaves the server.