Everyday care
creekX looks after itself: it restarts if it ever stops, and starts with the server. For the
rest, there is one command, creekx, run on the server.
The commands
| Command | What it does |
|---|---|
sudo creekx status |
Is it running, which version, the licence and the trial |
sudo creekx logs |
What it has been saying (add -f to keep following) |
sudo creekx restart |
Restart it |
sudo creekx owner |
Set a new password for the owner |
sudo creekx email |
Let creekX send email (below) |
sudo creekx domain NAME |
Use https at a domain pointed at this server |
sudo creekx backup |
Back up (Backups and moving) |
sudo creekx licence FILE |
Add a licence file |
sudo creekx metrics |
Where monitoring tools such as Prometheus read its numbers |
Set up email
With email, people who forget their password can reset it, invitations arrive by themselves, and alerts reach you. creekX sends through a mail account you already have.
-
Find your SMTP settings
Your email provider's help pages list its "SMTP" or "outgoing mail" settings: a server name, a port (587 or 465), a user name and a password. Many providers want an app password made for this.
-
Run the command
sudo creekx emailAnswer its questions. It sends you a test email first, and keeps the settings only if it arrives.
sudo creekx email test [email protected] sends another test;
sudo creekx email off stops email.
Upgrade
Run the install line again:
curl -fsSL https://creekx.io/get.sh | sudo bash
Everything is kept. If the new version does not start, the previous one is put back by itself. Channels pause briefly while it restarts.
See how the server is doing
- More → Server: processor, memory, disk and data going out, live.
- More → Help: checks every part of the server and says what to do about anything that is not fine.
Keep Ubuntu itself up to date too:
sudo apt update && sudo apt upgrade.