Quickstart

Quickstart

Get a ModulaCMS project running in three steps. This guide assumes you have the modula binary installed. If not, follow the Installation guide first.

1. Create a project

mkdir mysite && cd mysite
modula init

modula init runs the setup wizard, creates your database, seeds default roles and permissions, and registers the project. For non-interactive setup:

modula init --yes --admin-password your-password

2. Start the server

modula serve

ModulaCMS starts three servers:

Server Address Purpose
HTTP localhost:8080 REST API + admin panel
HTTPS localhost:4000 TLS-secured API
SSH localhost:2233 Terminal UI

Good to know: If you used the interactive installer without setting a password, check the startup logs for the generated admin credentials.

3. Connect

Web admin panel -- open http://localhost:8080/admin/ and log in with system@modulacms.local and your password.

Terminal UI -- run ssh localhost -p 2233.

REST API:

curl -X POST http://localhost:8080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "system@modulacms.local", "password": "YOUR_PASSWORD"}' \
  -c cookies.txt

curl http://localhost:8080/api/v1/datatype -b cookies.txt

Once the project is registered, you can manage it from any directory:

modula serve mysite         # start the server for this project
modula tui mysite           # launch TUI for this project
modula connect mysite       # connect via SSH/TUI

Next steps