Nexio CRM Core

Installation guide

The same guide that comes with the download (INSTALL.md) · Version 1.0.0

Nexio CRM Core is a self-hosted CRM for managing contacts, deals and follow-ups.
It runs on your own computer or server with Docker. Your data stays with you: nothing is sent to us.


1. What you need

  • Docker — install Docker Desktop (Windows / Mac) or Docker Engine (Linux).
  • About 300 MB of disk space.

2. Start the CRM (5 minutes)

  1. Unzip nexio-crm-core-<version>.zip into a folder you'll keep (for example C:\nexio-crm or ~/nexio-crm).
  2. Open a terminal in that folder and run:
    docker compose up -d

    The first start takes a minute or two while the image is built.

  3. Open http://localhost:3000 in your browser.
  4. The setup wizard appears: enter your business name, currency and your admin account. Done.

To use it from other computers on your network, open http://<this-computer's-IP>:3000.

3. Add your team

Go to Settings → Users & roles → Add user. Each person gets their own username and a temporary password
(they choose their own at first sign-in).

RoleCan do
AdminEverything, including settings, users, import/export, backups and deleting
MemberWork with contacts, deals, follow-ups, notes and files
ViewerRead only

Every user can turn on two-factor authentication from their account (click their name at the bottom-left).

4. Email reminders (optional)

Under Settings → Email reminders, enter the SMTP details from your email provider
(Google Workspace, Microsoft 365, Zoho, SendGrid, Mailgun, Amazon SES…), then click Send a test email.

  • Each user with an email address gets a daily digest of their overdue and due-today follow-ups.
  • Users get an email when someone assigns them a follow-up.
  • Set your time zone in docker-compose.yml (TZ: "Europe/London", TZ: "America/New_York"…) and restart: docker compose up -d.

Gmail / Google Workspace: use smtp.gmail.com, port 587, STARTTLS, and an App password (not your normal password).

5. Import your existing contacts

Settings → Import & export → Choose a CSV file. Export from Excel, Google Sheets, Outlook, HubSpot, Pipedrive etc. as CSV.
You match the columns before anything is imported. Contacts whose email already exists are skipped.


Everyday commands

Run these in the CRM folder:

WhatCommand
Startdocker compose up -d
Stopdocker compose down (your data is kept)
See logsdocker compose logs -f
Restartdocker compose restart

Backups — please read

All data lives in the Docker volume nexio-data: the database, uploaded files, and the file secret.key
(the encryption key for files and 2FA). Back up the whole volume, not only the database.

To copy everything to a backup folder next to the CRM (takes a few seconds; the CRM is paused meanwhile):

docker compose stop
docker compose cp crm:/data ./backup     # the ./backup folder must not exist yet
docker compose start

Keep the backup folder somewhere safe (another disk, cloud storage). Rename it with the date if you keep several.

From the app you can also download a database copy: Settings → Backup & data → Download backup,
and export contacts and deals to CSV.

Restore a backup folder (replaces the current data):

docker compose down
docker run --rm -v nexio-crm_nexio-data:/data -v "${PWD}/backup:/backup" alpine sh -c "rm -rf /data/* && cp -a /backup/. /data/ && chown -R 1000:1000 /data"
docker compose up -d

Updating to a new version

  1. Back up (see above).
  2. Unzip the new version over the old folder (your data is in the Docker volume, not in the folder).
  3. Run docker compose up -d --build.

Database changes are applied automatically on start.

Locked out?

If you forgot the admin password or lost your 2FA phone, run this in the CRM folder:

docker compose exec crm npm run reset-admin

It prints a new one-time password for the first admin (and turns off its 2FA).
For a specific user: docker compose exec crm npm run reset-admin -- <username>.

Putting it on the internet (optional)

For access from outside your network, run the CRM on a server (any VPS with Docker) behind a reverse proxy
that provides HTTPS — for example Caddy, Nginx or Traefik. Then set these in docker-compose.yml:

    environment:
      HTTPS: "1"
      TRUST_PROXY: "1"

Never expose the CRM over plain http:// on the internet. A minimal Caddy example (Caddyfile):

crm.yourcompany.com {
    reverse_proxy localhost:3000
}

Settings reference

VariableDefaultMeaning
TZUTCTime zone for the daily email digest
HTTPS01 when served over https:// (secure cookies, HSTS)
TRUST_PROXY01 when behind a reverse proxy
APP_ORIGINemptyOptional exact address, e.g. https://crm.example.com
SESSION_IDLE_HOURS12Sign out after this many idle hours
SESSION_MAX_DAYS14Sign in again after this many days
MAX_UPLOAD_MB25Largest file upload
ENCRYPTION_KEYemptyOptional; by default a key is generated into /data/secret.key

Security built in

Passwords hashed with Argon2id · optional 2FA with recovery codes · account lock after failed sign-ins ·
roles · protection against cross-site requests · uploaded files encrypted on disk and checked by content ·
security log of sign-ins, exports and deletions.