Installation

Requirements

• A Linux server (Debian, Ubuntu or similar) with 4 GB of memory and 20 GB of disk. Add 6 GB if you plan to turn on the ingest gateway.
• A 64-bit processor: x86_64 or arm64.
• A domain, for example bugs.example.com, with an A record pointing to the server.
• Ports 80 and 443 reachable from the internet: the certificate is issued automatically.
• Root access (sudo), plus curl and openssl, which most servers already have.

You do not need to install PostgreSQL, a web server or Docker yourself. Everything runs in containers that the installer starts; see Database for what is inside.

Install

Run this on the server:

curl -fsSL https://get.closeyour.it | sudo bash

The script:

1. checks Docker and the compose plugin, and installs them if they are missing;
2. asks for the domain, an email for the HTTPS certificate and the administrator email;
3. asks for an SMTP server (you can skip it and add it later);
4. warns you if the domain does not point to this server yet;
5. writes everything to /opt/closeyourit, with every secret key generated on the spot;
6. starts the app, the worker, PostgreSQL and Caddy, and waits up to 5 minutes for the app to answer;
7. turns on the nightly backup, at 03:00.

At the end it prints the address, the administrator email and the administrator password once. It is not shown again: write it down, then change it after the first sign-in.

Install without questions

Set the answers beforehand and the script does not ask for them:

curl -fsSL https://get.closeyour.it | sudo \
  DOMAIN=bugs.example.com \
  ACME_EMAIL=ops@example.com \
  ADMIN_EMAIL=you@example.com \
  SMTP_ADDRESS=smtp.example.com SMTP_PORT=587 \
  SMTP_USERNAME=user SMTP_PASSWORD=secret \
  MAIL_FROM="CloseYourIt <noreply@example.com>" \
  bash

If Docker is missing the script installs it: in a terminal it asks first, without one (cloud-init, CI) it goes ahead.

First sign-in

1. Open https://<your-domain> and sign in with the administrator email and the printed password.
2. Set up the second factor: the administration area stays closed until you do.
3. In the administration area, create your first organization.
4. Inside it, create a project, then an ingest token in the project settings.
5. Connect an application: see Connect your apps.

Without an SMTP server CloseYourIt sends no email at all: no invitations, no password reset, no alerts by email. Add it before inviting other people; see Settings.

What lives where

Keep the secret keys safe

Copy .env to a safe place right after the install, and again whenever you change it.

Uninstall

cd /opt/closeyourit && docker compose --profile ingest down --volumes
rm -rf /opt/closeyourit /usr/local/bin/closeyourit /etc/cron.d/closeyourit