Skip to main content

Configuration via Runtime Flags

Configuration is generally done through the Owncast administration site located on your server under /admin, however, there are a number of runtime flags you can set when starting Owncast to modify its behavior.

Most admins never need these. Use the admin UI for normal configuration. The flags here are mainly for recovery, such as resetting a lost admin password, or for scripted and automated startups.

You can run Owncast with --help to see a full list of available runtime flags.

Flag reference

FlagValuePurposePersistence
--adminpasswordpasswordSet a new admin password. The usual way to recover access if you lost yours.Saved to the database
--backupdirdirectory pathDirectory where database backups are written.This run only
--databasefile pathUse a database file other than the default data/owncast.db.This run only
--enableDebugFeaturesnoneEnable additional debugging options.This run only
--enableVerboseLoggingnoneEnable additional logging.This run only
--followervalidationintervalsecondsHow often Fediverse followers are re-validated.This run only
--logdirdirectory pathDirectory where logs are written.This run only
--restoreDatabasebackup file pathRestore a database backup, then exit. Restart Owncast afterwards.One-time action
--rtmpportport numberSet the listen port for the RTMP server. Default is 1935.Saved to the database
--streamkeykeySet a temporary stream key. While it's in effect the Stream Keys admin tab is hidden.This session only
--webserveripIP addressForce the web server to listen on a specific IP address.Saved to the database
--webserverportport numberForce the web server to listen on a specific port. Default is 8080.Saved to the database

Flags marked "saved to the database" change your stored server configuration. The new value keeps applying on later starts even after you drop the flag. The others only affect the run they're passed to.

Examples

Reset a lost admin password:

owncast --adminpassword mynewpassword

Set a temporary stream key for this session:

owncast --streamkey mystreamkey

Run on custom ports. You can also change ports in the admin, which requires a restart to take effect:

owncast --webserverport 9090 --rtmpport 2945

Restore a database backup:

owncast --restoreDatabase /path/to/owncastdb.bak

Improve this page

See something missing or incorrect? Edit this page and improve the documentation for everyone.

Contributors to this documentation
Gabe KangasGabe Kangas
S
Solomon Mithra
mtabrizmtabriz
J
Jannik
J
Jannik Volkland

Related Documents