Skip to content
Enjazy documentation

Install Enjazy Server

This guide is for the person who installs and looks after Enjazy Server for a team or a company. It covers what you need, installing and starting the server, setting it up in the browser, the server licence, HTTPS, outgoing email, web push reminders, the AI assistant, backups, updates, and installing the desktop app on your team's computers. Every setting is listed in Environment variables at the end.

Once the server runs, you manage people and settings in the admin console: see the server administrator guide.

Requirements

Install and run

  1. Download the server archive (enjazy-server-<version>.zip) from the Enjazy download page and extract it.
  2. From the extracted folder, start the server:
node apps/server/dist/server.mjs

The server listens on port 8787. At that address it serves the Enjazy web app, the admin console (/console/) and this documentation (/docs/). It keeps its data in ./data/ in the folder you start it from, unless you set other folders (see Environment variables).

The first time it starts with no settings, the server opens the setup wizard: see Setup in the browser.

Docker

Build the image from the extracted archive and run it:

docker build -t enjazy-server -f apps/server/Dockerfile .
docker run -p 8787:8787 -v enjazy-data:/data enjazy-server

The container runs as a normal (non-root) user, listens on port 8787 and keeps all its data in the /data volume. Keep that volume when you recreate the container: it holds every account, every task and the settings the setup wizard saved.

Setup in the browser

When the server starts for the first time with no settings, it prints one line with the wizard's address and a one-time setup code:

Enjazy setup: open http://localhost:8787/setup in a browser and enter the setup code XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

Open the address, then:

  1. Choose the language and enter the setup code. The code is shown only in that line, and it stops working once setup is done or the server stops. After five wrong codes from one address, that address must wait 15 minutes.
  2. Enter the server's public address. The wizard checks that it can be reached.
  3. Set up email (optional), and use Send test email to check it.
  4. Create the first administrator.
  5. Set up the AI provider (optional), with Test connection.
  6. Choose Save and start Enjazy.

The wizard saves the settings in a .env file in the data folder (./data by default, /data in Docker). Passwords and keys go in their own files in the secrets/ folder next to it, readable only by the server. It never overwrites an existing .env. The server then starts at once. AI set up here stays off until Test connection succeeds in the admin console.

Back up the data folder as a whole: it holds these settings. If the settings are lost after setup, the server refuses to start and names the folders it looked in; restore .env from your backup.

Without the wizard. For an unattended or Docker install, pass the settings as environment variables instead (see Environment variables). Set ENJAZY_AUTH=accounts and create the first administrator with ENJAZY_ADMIN_USER, ENJAZY_ADMIN_EMAIL and ENJAZY_ADMIN_PASSWORD (or ENJAZY_ADMIN_PASSWORD_FILE), then sign in to the console at /console. Any setting you pass this way skips the wizard.

The wizard always sets up the server with accounts: each person signs in, and the server keeps each person's and each shared list's tasks in its data folder. A server can instead run as one shared workspace without accounts (ENJAZY_AUTH=none, or api-key to require a key), which is how Enjazy 1.x servers worked; only that mode can store its data in MySQL. Set it up by hand in .env instead of running the wizard.

Server licence

Enjazy Server is free. Server Pro unlocks the paid features for everyone on the server. One licence covers one server.

Buy or install a licence

A forged or changed key is refused straight away. Keys in the old format don't work any more: ask Enjazy support for a new server key.

Lifetime licence

A lifetime server licence gives the same features as Server Pro, never expires and includes updates. It has no subscription, so there is no renewal and no Manage subscription. It is still one key for one server, and you move it the same way. Lifetime purchases are final.

Server ID and checks

Move a licence to another server

A key belongs to the first server that uses it. To move it, choose Detach license on the old server, then install the key on the new one. If the old server hasn't checked in for more than a day, ask Enjazy support to release the key, and include the new server's ID. A key used elsewhere, cancelled, released or past its paid period drops the server to Free with a warning.

Updating an older server

Update an older server to use the current server licences. Older servers keep their current licence until it expires (at most 30 days), then use Free until they update. If your settings still have ENJAZY_LICENSE_OWNER_TOKEN, remove it: it is no longer used. Use a server key instead, and keep server-identity.key in the data folder: it is the server's identity.

HTTPS and reverse proxy

Use HTTPS. You have two options:

  1. Built-in HTTPS. Set ENJAZY_TLS_CERT and ENJAZY_TLS_KEY to your certificate and key files. You can also set ENJAZY_HTTP_PORT to keep a plain-HTTP port open.
  2. Reverse proxy (nginx, Caddy, a load balancer). Let the proxy handle HTTPS and forward to the server's host and port. Then:

Plain HTTP on a local network. Browsers allow the console sign-in, passkeys and two-step setup only on https:// addresses and on localhost. On a plain-HTTP address such as http://server1.lan:8787, the console sign-in keeps returning to the login page and those features fail in every browser. Put HTTPS in front of the server as described above.

The server always serves the Enjazy web app at its own address, next to the console.

Outgoing email

The server sends email for invitations, password reset links and email confirmation. Set ENJAZY_SMTP_URL, or ENJAZY_SMTP_HOST with ENJAZY_SMTP_PORT, ENJAZY_SMTP_USER, ENJAZY_SMTP_PASSWORD (or ENJAZY_SMTP_PASSWORD_FILE) and ENJAZY_SMTP_SECURE. For encryption, ENJAZY_SMTP_SECURE=true uses a secure connection from the start (usually port 465), and ENJAZY_SMTP_REQUIRE_TLS=true requires STARTTLS on a normal port (usually 587). The setup wizard keeps the choice you make there.

Without outgoing email, the server sends no email: password reset links and confirmation emails can't go out. The console's Settings page shows whether email is set up.

Web push reminders

People who use the Enjazy web app (installed, or open in a browser) can get task reminders even when no Enjazy tab is open: they turn it on in Settings › Notifications › Push notifications. The server sends the reminders through the browser's push service (Google for Chrome, Edge on some systems, Opera and Samsung Internet; Mozilla for Firefox; Microsoft for Edge; Apple for Safari and for web apps added to the Home Screen on iPhone and iPad).

AI assistant (bring your own key)

The AI assistant suggests sub-tasks and a priority for a task, summarizes the week, and plans a goal: a person describes what they want to plan and gets a plan of projects, lists, tasks and sub-tasks to choose from before anything is added. On your server it runs with your own AI provider account and key. The apps never hold the key: they ask your server, and your server asks the provider.

AI works only when the server uses accounts (ENJAZY_AUTH=accounts, as the setup wizard sets it), because each request counts against a signed-in person. A shared workspace without accounts has no AI.

AI is included with Enjazy Server Free.

When AI is on

AI is off until both of these are true:

  1. The provider type, base URL, model and key are all set.
  2. Test connection in the admin console (Settings → AI assistant) succeeded for exactly that setup.

Any change of the provider type, base URL, model or key needs a new test, including a new key in the key file. A failed test turns AI off. Changing the timeout, the answer length or the daily limit doesn't need a new test. The server administrator guide describes the console section.

Once AI is on, a slow or unreachable provider doesn't turn it off. The person sees "Couldn’t reach the AI provider" with Try again, and the request isn't counted.

A model on your own machine

A model on your own machine (for example served by llama.cpp or Ollama with an OpenAI- or Anthropic-compatible API) answers much more slowly than a hosted one. Set the AI timeout to 120 seconds (ENJAZY_AI_TIMEOUT_MS=120000, or 120 in Settings → AI assistant), then run Test connection. A plan always gets up to 120 seconds, whatever the timeout, because a whole plan takes 25 seconds or more on a local model. If a reverse proxy sits in front of the server, let it wait at least as long for an answer (for example proxy_read_timeout 130s; in nginx); otherwise the proxy gives up first.

Provider types

The key

The key is never put in a settings value. Give it in one of two ways:

  1. Key file. Set ENJAZY_AI_KEY_FILE to a file that holds only the key. Make the file readable only by the user the server runs as. The server reads the file each time it needs the key; an unreadable or empty file counts as no key.
  2. Admin console. Paste the key in Settings → AI assistant. It is write-only: no page shows it again. The server stores it encrypted.

A key entered in the console wins over the key file. Remove it in the console to use the key file again.

Settings

Set the provider with the AI settings in Environment variables, in the admin console, or both. A value set in the console wins; clearing a field in the console goes back to the settings value. The answer length (ENJAZY_AI_MAX_TOKENS) can only be set in the settings.

Example settings. The key goes only in the key file:

ENJAZY_AUTH=accounts
ENJAZY_AI_PROVIDER=openai
ENJAZY_AI_BASE_URL=https://api.deepseek.com
ENJAZY_AI_MODEL=deepseek-chat
ENJAZY_AI_KEY_FILE=/etc/enjazy/ai-key

Create the key file on Linux:

sudo install -m 600 -o enjazy -g enjazy /dev/null /etc/enjazy/ai-key
sudo nano /etc/enjazy/ai-key    # paste the key, save

Use the user the server runs as in place of enjazy. In Docker the server runs as node: mount the key file read-only into the container and set ENJAZY_AI_KEY_FILE to its path there. Then restart the server, sign in to the admin console and choose Test connection.

Daily limit

You can set a daily limit per person in the admin console. The default is no limit. One successful request counts as one; a failed request isn't counted. A plan counts as one request; Regenerate in the planner asks again and counts as another. The count starts again at midnight UTC. When a person's requests for the day are used up, the app shows when they start again.

The AI usage section of the console (in Settings, below AI assistant) shows how many requests the server answered today and in the last 30 days, with the daily limit. It shows counts only.

Privacy

Backups

Back up the whole data folder. It holds:

To restore, stop the server, put the files back, and start it again. Backups hold people's data, never their PIN, their passwords in readable form, or what is kept only on their devices.

To back up or restore one person's tasks, use the account's page in the admin console (see the server administrator guide).

Updating the server

Your accounts, tasks, settings and licence all live in the data folder, never in the program files, so an update replaces only the program.

  1. Stop the server, then back up the data folder. The server makes no copy of its own before it updates your data, so this backup is your way back.
  2. Replace the program.
  1. Start the server the same way as before: from the same folder for an archive install, so it finds ./data (or with the same data settings, if you moved the data folder). If it starts with an empty data folder, it opens the setup wizard as for a new server: stop it and check the folder.

As it starts, the server updates the accounts database to the new version. Each person's tasks and each shared list are updated the first time they are opened after the update. An older version may refuse to open data that a newer version has updated, so to go back, restore the data folder from your backup together with the older program.

The admin console's Settings page lists what changed in each version (Change log).

Moving from Enjazy Server 1.x

Enjazy moves a 1.x server into a new data folder; it never changes the 1.x data. It carries accounts, passwords, two-step verification, passkeys, shares, invitations, plans, subscriptions and keys. Contact Enjazy support before you move, and we'll guide you through it.

Enjazy desktop apps on your team's computers

For administrators who install the Enjazy desktop app for their users:

Environment variables

These are the settings you can give the server, as environment variables or in its .env file. Each has its default. Most servers need only a few: the setup wizard writes them for you.

VariableDefaultPurpose
ENJAZY_HOST0.0.0.0The network address the server listens on.
ENJAZY_PORT8787The port the server listens on.
ENJAZY_AUTHnoneHow people use the server: accounts (each person signs in; the setup wizard sets this), none (one shared workspace, no sign-in) or api-key (one shared workspace that needs a key).
ENJAZY_API_KEYS(empty)With api-key: the keys that are accepted, separated by commas.
ENJAZY_API_KEYS_SYNCfalseWith api-key: true also requires a key to sync. Leave it off while Enjazy 1.x apps still sync with the server; turn it on once every app sends a key.
ENJAZY_DB_DRIVERsqliteThe shared workspace's database: sqlite (a file in the data folder) or mysql.
ENJAZY_DB./data/enjazy-server.dbThe shared workspace's database file.
ENJAZY_MYSQL_HOST127.0.0.1The MySQL host, with ENJAZY_DB_DRIVER=mysql.
ENJAZY_MYSQL_PORT3306The MySQL port.
ENJAZY_MYSQL_USERenjazy_userThe MySQL user.
ENJAZY_MYSQL_PASSWORD(empty)The MySQL password.
ENJAZY_MYSQL_PASSWORD_FILEunsetA file that holds the MySQL password; ENJAZY_MYSQL_PASSWORD wins when both are set.
ENJAZY_MYSQL_DATABASEenjazy_dbThe MySQL database name.
ENJAZY_MYSQL_TLS_CAunsetA CA certificate (PEM) for an encrypted MySQL connection.
ENJAZY_MYSQL_TLS_REJECT_UNAUTHORIZEDtrueWhether to check the MySQL server's certificate.
ENJAZY_AUTH_DB./data/auth.dbWith accounts: the accounts database file. Its folder is the data folder.
ENJAZY_USERS_DIR./data/usersWith accounts: the folder that holds each person's tasks.
ENJAZY_ISSUERunsetThe server's public address, used in links and emails.
ENJAZY_CORS*Other web addresses allowed to use this server from a browser, separated by commas; unset or * allows any.
ENJAZY_TLS_CERTunsetYour certificate file, to turn on built-in HTTPS.
ENJAZY_TLS_KEYunsetYour certificate's key file, for built-in HTTPS.
ENJAZY_HTTP_PORTunsetAn extra plain-HTTP port next to built-in HTTPS.
ENJAZY_TRUST_PROXYloopbackWhich proxies the server trusts to pass on each person's address: none, loopback, or a list of addresses.
ENJAZY_ADMIN_USERunsetWithout the wizard: the first administrator's username.
ENJAZY_ADMIN_EMAILunsetWithout the wizard: the first administrator's email.
ENJAZY_ADMIN_PASSWORDunsetWithout the wizard: the first administrator's password.
ENJAZY_ADMIN_PASSWORD_FILEunsetA file that holds the first administrator's password; ENJAZY_ADMIN_PASSWORD wins when both are set.
ENJAZY_SIGNUPSfalseWhether anyone who can reach the server can create an account. You can also change this in the console.
ENJAZY_SETUP_SKIP_VALIDATIONfalseSkips the public address check at first start. Only for trying the server on your own computer.
ENJAZY_SMTP_URLunsetYour mail server, as one SMTP address (smtp://user:password@host:port).
ENJAZY_SMTP_HOSTunsetYour mail server's host (when ENJAZY_SMTP_URL is unset).
ENJAZY_SMTP_PORT587Your mail server's port.
ENJAZY_SMTP_USERunsetThe mail account's user name.
ENJAZY_SMTP_PASSWORDunsetThe mail account's password.
ENJAZY_SMTP_PASSWORD_FILEunsetA file that holds the mail password; ENJAZY_SMTP_PASSWORD wins when both are set. The setup wizard uses this one.
ENJAZY_SMTP_SECUREfalsetrue uses a secure connection from the start (usually port 465).
ENJAZY_SMTP_REQUIRE_TLSfalsetrue requires STARTTLS on a normal port (usually 587).
ENJAZY_MAIL_FROMunsetThe sender address; unset uses no-reply@ and your server's host name.
ENJAZY_MAIL_FROM_NAMEunsetThe sender name; unset uses your server's host name.
ENJAZY_MAIL_TRANSPORTsmtp when a mail server is set; otherwise none on a live server and file on a test serversmtp sends email; none sends none; file saves each email as a file in the data folder's outbox/ instead of sending it.
ENJAZY_SUPPORT_EMAILunsetYour support email address, shared with the apps that connect to this server.
ENJAZY_WEB_APP_ORIGINunsetThe public address used in links people copy, when a proxy changes the host name.
ENJAZY_PRIVACY_URLunsetWhere /privacy leads; unset shows "not found".
ENJAZY_TERMS_URLunsetWhere /terms leads; unset shows "not found".
ENJAZY_HELP_URLunsetWhere /help leads; unset shows "not found".
ENJAZY_STATUS_URLunsetThe address of your status page, shared with the apps that connect to this server.
ENJAZY_LOG_LEVELinfoHow much the server writes to its log: fatal, error, warn, info, debug, trace or silent.
ENJAZY_LICENSE_KEYunsetYour server key from Enjazy. It wins over a key installed in the console, which then shows it read-only. See Server licence.
ENJAZY_LICENSE_OWNER_TOKENunsetNo longer used: remove it and use a server key. While it is set, the console's licence section says so.
ENJAZY_REQUIRE_VERIFIED_EMAILfalsetrue makes each person confirm their email address before they can share lists or invite people. Turn it on only when outgoing email works, so people get the confirmation link. Administrators can mark an address as confirmed in the console.
ENJAZY_WEBHOOKS(empty)Shared workspace only: addresses that receive a signed notice when data changes, separated by commas.
ENJAZY_WEBHOOK_SECRETunsetThe secret used to sign those notices.
ENJAZY_WEBHOOK_POLL_MS1000How often, in milliseconds, the server looks for changes to send.
ENJAZY_AI_PROVIDERunsetThe AI provider type: openai (OpenAI-compatible) or anthropic (Anthropic-compatible). See AI assistant.
ENJAZY_AI_BASE_URLunsetThe provider's address, for example https://api.deepseek.com.
ENJAZY_AI_MODELunsetThe provider's model name, for example deepseek-chat.
ENJAZY_AI_KEY_FILEunsetA file that holds only the provider's API key. The key itself is never a settings value.
ENJAZY_AI_TIMEOUT_MS30000How long one AI request may take, in milliseconds, from 1000 to 120000.
ENJAZY_AI_MAX_TOKENS1024The longest answer the provider may write (in tokens), from 64 to 8192.
ENJAZY_PUSH_CONTACTunset (your support email, then the server's https:// address)Where push services can reach you: mailto:you@example.com or an https:// address.
ENJAZY_PUSH_VAPID_FILEpush-vapid.json in the data folderThe push keys file. Created at first start when missing; keep it with your backups.
ENJAZY_ENVunsetSet to production on a live server. Without it the server runs as a test server.
NODE_ENVunsetproduction does the same as ENJAZY_ENV=production.

On a live server without a mail server, the server sends no email until you set one up; on a test server it saves emails in the data folder's outbox/ instead (see Outgoing email).