Settings reference
Every environment variable and flag the server reads, with its default.
The server's own settings are environment variables, which you normally keep in /etc/chronoslice/env. This page lists all of them, and says where each other kind of setting lives.
How settings are read
Each chronoslice serve setting can be given as an environment variable or as a command-line flag. A flag wins over the variable.
The chronoslice commands you run at a shell read settings from three places. A variable that's already set in your shell always wins over the others.
- Your shell's environment, and any flags.
- A file named
.envin the folder you run the command from, or one of its parent folders, if there is one. /etc/chronoslice/env, if it exists. SetCHRONOSLICE_ENV_FILEto read another file instead.
That third place is why sudo chronoslice update and sudo chronoslice licence find the same database the service uses. Only root can read /etc/chronoslice/env when you set it to mode 600, so run those commands with sudo.
[!NOTE] The file is read as
KEY=valuelines, the way systemd reads it. A value can contain spaces, and quotes around it are optional.
Server settings
These are for chronoslice serve, except CHRONOSLICE_DB, which every command uses.
| Variable | Flag | Default | What it does |
|---|---|---|---|
CHRONOSLICE_DB |
--db |
sqlite://chronoslice.db |
The SQLite database. Use sqlite:///var/lib/chronoslice/chronoslice.db for an absolute path. The default is a file in the folder you run from. |
CHRONOSLICE_BIND |
--bind |
127.0.0.1:7340 |
The address and port to listen on. Keep it on 127.0.0.1 and put a reverse proxy in front. |
CHRONOSLICE_PUBLIC_URL |
--public-url |
none | The address people reach ChronoSlice at, such as https://time.example.com. Used for links in emails, Stripe's return address and the Stripe webhook address. |
CHRONOSLICE_SECURE_COOKIES |
--secure-cookies |
off | Marks the session cookie Secure. Set it to true when you serve over HTTPS. Only true and false are accepted. |
CHRONOSLICE_SMTP_URL |
--smtp-url |
none | Where email goes out. smtps://user:pass@host:465, smtp://user:pass@host:587?tls=required, or file:///folder for testing. Email is off without it. |
CHRONOSLICE_MAIL_FROM |
--mail-from |
none | The sender address, such as "Your Studio <[email protected]>". Required when CHRONOSLICE_SMTP_URL is set. |
CHRONOSLICE_SETUP_TOKEN |
--setup-token |
none | A secret the first-run setup page asks for. Leading and trailing spaces are removed, and an empty value counts as not set. |
Other variables
| Variable | Default | What it does |
|---|---|---|
RUST_LOG |
chronoslice=info |
How much the server writes to its log. info also shows messages from the libraries it uses, and chronoslice=debug shows more of ChronoSlice's own. |
CHRONOSLICE_ENV_FILE |
/etc/chronoslice/env |
The settings file the commands read when they start. |
CHRONOSLICE_LICENCE_CHECKS |
on | Set to off to stop the once-a-day check with the licence store. You can still check by hand. See Buying and entering a licence. |
CHRONOSLICE_PASSWORD |
none | The password for chronoslice setup and chronoslice user set-password. Without it, the command prompts, or reads the first line of standard input. |
TOGGL_API_TOKEN |
none | Your Toggl API token, for import toggl and reconcile toggl (the --token flag). |
SQUARE_ACCESS_TOKEN |
none | Your Square access token, for import square (the --token flag). |
Settings that live in the app
Most of what you'll change is in the web app, not in the settings file:
- Settings has your profile and password, the organization, Reports & branding, API tokens and Licence.
- Invoices, then Settings, has invoice numbering, payment terms, default notes, tax, how hours are written, Online payments (Stripe) and Email (reminders, receipts, attached files and block alerts).
Those settings are stored in the database, so they're in your backups. The database also holds your Stripe secret key and your clients' details, so keep backups private.
Related
- Install on Linux shows a complete settings file.
- Command reference lists the flags of every command.
Still stuck?
Send us a request: it goes to the people who build ChronoSlice, and the reply comes by email. Include your ChronoSlice version (Settings › Licence shows it) and what you tried.