Docs menu
Documentation
Getting started
What ChronoSlice is, what you need to run it, and how to get from download to your first account.
- What ChronoSlice isThe server, the web app and the Mac app, what they do together, and what ChronoSlice leaves out.
- RequirementsWhat you need before you install: a Linux or Mac server, or Docker, a domain with HTTPS, and optionally email and Stripe.
- Quick startFrom download to your first account in about ten minutes, with a link to the full page for each step.
Installing
Put ChronoSlice on a Linux server, a Mac or Docker, put HTTPS in front of it, set up the first account and email, and back it up.
- Install on LinuxPut the ChronoSlice binary on a Linux server, give it a user, a data folder and a settings file, and run it with systemd.
- Install on macOSPut the ChronoSlice binary on a Mac that stays on, give it a data folder and a settings file, and run it as a launchd daemon.
- Run with DockerRun ChronoSlice from its Docker image with Docker Compose, keep the data in a volume or a folder, and update by pulling the new image.
- Reverse proxy and HTTPSServe ChronoSlice over HTTPS with Caddy or nginx, and set the two settings that go with it.
- The first accountCreate the owner account from the setup page or the command line, and protect setup with a token.
- EmailConnect ChronoSlice to an SMTP account so it can send invoices, reminders and receipts, and test it first with files.
- Settings referenceEvery environment variable and flag the server reads, with its default.
- Backups and restoringBack up the one SQLite file safely, use the backups that updates make, stream changes with Litestream, and restore.
Licence and updates
The trial, entering and moving your key, updating the server, and what happens when updates end.
- The trialThirty days with every feature and up to five users, then what changes when the server goes read-only.
- Buying and entering a licenceThe three editions, where your key comes from, how to enter it, and what the server tells the store.
- Moving to another serverGive the key's seat back on the old server, then enter the key on the new one.
- UpdatingInstall the newest release your licence covers with one command on Linux or macOS, pull the new image on Docker, and what the command does step by step.
- Renewing and upgradingAdd a year of updates, or move up an edition, from your account, and how the server finds out.
- When updates endYour licence never expires, but a release dated after your updates ended won't start. What that means and what to do.
Using ChronoSlice
Track time, organize clients and projects, run reports, send invoices and get paid.
- Tracking timeStart a timer, log time you already worked, use the one-line quick entry, and edit your week in the timesheet and calendar.
- Clients, projects, tasks and tagsSet up who the work is for, what it is, and how it is billed, including how hourly rates cascade.
- People and rolesWhat owners, admins, managers and members can do, how to deactivate people, and how your edition limits active users.
- ReportsFilter and group your time, round it, save reports, share them with a link, and export PDF or CSV.
- InvoicesMake an invoice from tracked time, edit its lines, number it, send it, share it with the client, and void it.
- Recurring invoicesBill hosting, retainers and renewals on a schedule, with the wording filled in for each period.
- Getting paid with StripeConnect Stripe so clients pay an invoice online by card or US bank account, and charge saved payment methods.
- Reminders and notificationsReminders before and after an invoice is due, receipts, block alerts, and the other emails ChronoSlice sends.
- Support hour blocksSell prepaid blocks of hours, draw them down as you track time, warn clients and yourself, and show clients where they stand.
- API tokensMake a token for a script or app, call the HTTP API with it, and find the OpenAPI document.
Mac app
The free menu bar timer and the Day, Week and Calendar views, with offline sync.
- Installing and signing inInstall the free Mac app, point it at your server, and sign in. What it keeps on your Mac, and how to sign out.
- The menu bar timer and shortcutsStart and stop a timer from the menu bar, the global shortcut, quick entry, and every keyboard shortcut.
- Day, Week and CalendarThe three views in the Mac app's main window: edit a day beside its timeline, type hours into a week, and drag entries on a calendar.
- Working offline and syncHow the Mac app keeps a local copy, syncs with your server, and handles changes the server refuses.
- When the server is read-onlyWhat the Mac app shows and does when the trial has ended, and how it recovers once a licence is entered.
Moving to ChronoSlice
Bring your history from Toggl Track or Square with the importers.
Help
Fixes for common problems, and every command the server understands.
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.