diff --git a/README.md b/README.md index b3ed620..272a806 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,34 @@ cyberpunk infrastructure dashboard with user authentication and docker deploymen ## quick start ```bash +# pull and run +docker run -d -p 8085:8085 -v dashd_data:/data sudoxreboot/dashd + +# or with compose +curl -O https://raw.githubusercontent.com/sudoxnym/dashd/master/docker-compose.yml docker compose up -d ``` dashboard available at `http://localhost:8085` +## docker compose + +```yaml +services: + dashd: + image: sudoxreboot/dashd:latest + ports: + - "8085:8085" + volumes: + - dashd_data:/data + environment: + - DASHD_SECRET=${DASHD_SECRET:-} + restart: unless-stopped + +volumes: + dashd_data: +``` + ## configuration set a custom jwt secret: @@ -37,12 +60,13 @@ DASHD_SECRET=your-secret-here ## development -run without docker: +build from source: ```bash -pip install -r requirements.txt -python backend.py & -# serve dashboard.html on port 8085 +git clone https://github.com/sudoxnym/dashd.git +cd dashd +docker build -t dashd . +docker run -d -p 8085:8085 dashd ``` ## architecture