Getting Started
Quick Start
Get a working CRANE instance running on your own machine. The installer downloads CRANE, generates a secure configuration automatically, and starts every service for you.
For system requirements, pre-flight checks, production deployment, or TLS setup, see the Installation & Deployment Guide. This Quick Start is for local testing only.
Docker builds the backend image and downloads the vulnerability database on the very first start. Subsequent starts are near-instant.
Prerequisites
- Docker Desktop installed and running.
- On Windows: Docker set to Linux containers (right-click the Docker tray icon to switch).
- Roughly 2 GB of free disk for the image and vulnerability database.
Linux / macOS
Open a terminal in the folder where you want CRANE installed, then run:
# install into a folder of your choice
cd ~/Desktop
curl -fsSL https://raw.githubusercontent.com/cra-norm-engine/crane/main/install.sh | bashWindows
Open PowerShell in the folder where you want CRANE installed, then run:
cd $HOME\Desktop
irm https://raw.githubusercontent.com/cra-norm-engine/crane/main/install.ps1 | iexPiping a remote script straight into a shell runs it immediately. If you prefer to review it first, see the Installation Guide → Understanding the Install Scripts section for detailed information and safe execution steps.
Manual setup (for advanced users)
Prefer to control the setup yourself? Clone the repo, configure .env, and run docker compose up -d. For detailed step-by-step instructions, see the Installation Guide → Development Setup.
Access the app
Once the services are healthy, CRANE is available at:
| Service | URL |
|---|---|
| App | http://localhost:5173 |
| API | http://localhost:8000/api/v1 |
| API docs | http://localhost:8000/docs |
Default login
| Field | Value |
|---|---|
admin@example.com | |
| Password | admin1234 |
You will be prompted to set a new password on first login. Do not expose an instance to a network until you have done so.
Online Demo
To see the online demo of the latest version of CRANE, use the credentials below:
- Email: demo@crane.com
- Password: Hca@U~8%dZ!iNT
- Step 1: Initiate the server at cra-compliance-tool.onrender.com and wait for 2 minutes.
- Step 2: Open CRANE at cra-compliance-tool-1.onrender.com and use the above credentials.
Remark: Do not enter any sensitive or private information in the online demo.