Documentation / Getting started

Troubleshooting

What to check when the install, the certificate, email or incoming data do not work.

Start here, whatever the problem:

closeyourit doctor     # disk, app, certificate, backup, ingest, version
closeyourit status     # which services are running
closeyourit logs       # what the app and the worker are saying

The installer stops

Message	What to do
`run it as root (sudo bash)`	run the command with `sudo`
`unsupported CPU`	the server is not `x86_64` or `arm64`
`curl is missing`, `openssl is missing`	install the package and run it again
`already has an install: use 'closeyourit update'`	CloseYourIt is already here; to update it run `closeyourit update`
`could not read the latest version from GitHub`	the server cannot reach GitHub; check its internet access
`the app did not start`	read the log: `cd /opt/closeyourit && docker compose logs app`

The address does not open, or the browser warns about the certificate

The certificate is issued only when all of these are true:

the domain points to this server (the installer warns you if it does not);
ports 80 and 443 are open, on the server and on the provider's firewall;
nothing else on the server is already using those ports.

Fix what is missing, then check what the web server says:

cd /opt/closeyourit && docker compose logs caddy

The certificate is requested again by itself: no need to reinstall.

No email arrives

SMTP_ADDRESS is empty in /opt/closeyourit/.env: CloseYourIt then sends nothing. Fill in the SMTP settings and run closeyourit restart. See Settings.
The settings are there but mail still does not arrive: closeyourit logs shows the error the SMTP server returned.
Mail arrives in spam: the domain in MAIL_FROM must allow your SMTP server to send for it (SPF and DKIM records at your DNS provider).

I lost the administrator password

Use "Forgot password" on the sign-in page. It needs working email: set up SMTP first if you skipped it.

An application sends data but nothing shows up

Send one request by hand and read the answer; see HTTP API.

Answer	Cause
`401`	the token is wrong, revoked, or it is the public key used where the secret token is needed
`404`	the project id in the address is not the token's project
`422`	the body is not what that address expects
`429`	too many requests: slow down and honour `Retry-After`
`202` with `accepted: 0`	the feature is off for that project, or the request looked like a bot
`202`, still nothing	the data is saved by the worker: check that `worker` is running with `closeyourit status`

The disk is filling up

df -h /opt/closeyourit
docker system df

Database: shorten how long data is kept for the noisiest projects. See Database.
Old versions: each update leaves the previous image behind. docker image prune removes the unused ones.
Ingest queue: it can reach 4 GB while the app is down, and empties once the app is back.

If it says the version was not found, check the number: nothing changed. Otherwise closeyourit update goes back to the previous version and files by itself and says so. The backup taken just before is in /opt/closeyourit/backups/. Read closeyourit logs to see why the new version did not start, then try again.

The country of visits is empty

The country database is not installed. See "Countries in web analytics" in Settings.

Still stuck

Open an issue on GitHub with the output of closeyourit doctor and the relevant lines of closeyourit logs. Remove tokens and passwords first.