Install Todomator with Node.js and PostgreSQL, Docker or Docker Compose

Todomator · todomator@1.7 todomatorinstalldockerpostgresql

Todomator needs the latest Node.js and a PostgreSQL database. Do not run database.sql yourself: Todomator uses that script internally when it starts on an empty database.

By hand

Install Node.js and PostgreSQL and create a database for Todomator.
Download the source code.
Install the dependencies in the root of the application:

npm install

Set the connection in the file config. It reads the environment variable DATABASE (line database (env) : DATABASE) and has a line database : postgresql://total:platform@127.0.0.1:5432/todomator as a model. The same file has $api : /api/ (the address of the API) and a mail line with the SMTP settings as a JSON object.
Run it (the start script is node index.js 8000):

node index.js

Open http://127.0.0.1:8000.

Docker Hub

docker pull totalplatform/todomator
docker run --env DATABASE='postgresql://user:pass@hostname/database' -p 8000:8000 totalplatform/todomator

Docker Compose

git clone https://github.com/totaljs/todomator.git
cd todomator
docker compose up

The first start

If the table tbl_ticket does not exist in the schema public, Todomator runs database.sql with a generated identifier, a secret and the password hash of the first user, then loads the configuration and the tags. With the environment variable DATABASE (Docker) it waits three seconds first. The script creates the statuses, the first user and the configuration. The server stays paused (PAUSESERVER('Database')) until the database is ready.

The README gives the default account:

login : info@totaljs.com
password : admin

The account is created with the name John Connor and administrator rights (sa). Change the password after signing in, and configure the settings.

Updating

For an existing installation the README points to the update scripts of the repository instead of database.sql: database_1-3.sql, database_1-4.sql, database_1-5.sql, database_1-6.sql and database-20240119.sql. Apply the ones that are newer than your version; the file version of the repository lists what each release changed (for example, version 1.7 added two-factor authentication, improved the search and the plugins of reports, bookmarks and users).