ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-11-10 08:57:25 +01:00
Code Issues Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Jan Eitzinger 2022-09-26 14:19:15 +02:00
parent 90425021ad
commit 2753cf5652
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -44,31 +44,26 @@ Please note that some views do not work without a metric backend (e.g., the Syst
```sh ```sh
git clone git@github.com:ClusterCockpit/cc-backend.git git clone git@github.com:ClusterCockpit/cc-backend.git
# Prepare frontend # Build binary
cd ./cc-backend/web/frontend cd ./cc-backend/
yarn install make
yarn build
cd ..
go build ./cmd/cc-backend
ln -s <your-existing-job-archive> ./var/job-archive
# Create empty job.db (Will be initialized as SQLite3 database)
touch ./var/job.db
# EDIT THE .env FILE BEFORE YOU DEPLOY (Change the secrets)! # EDIT THE .env FILE BEFORE YOU DEPLOY (Change the secrets)!
# If authentication is disabled, it can be empty. # If authentication is disabled, it can be empty.
cp configs/env-template.txt .env cp configs/env-template.txt .env
vim ./.env vim ./.env
#Optional: Link an existing job archive:
ln -s <your-existing-job-archive> ./var/job-archive
# This will first initialize the job.db database by traversing all # This will first initialize the job.db database by traversing all
# `meta.json` files in the job-archive and add a new user. `--no-server` will cause the # `meta.json` files in the job-archive and add a new user. `--no-server` will cause the
# executable to stop once it has done that instead of starting a server. # executable to stop once it has done that instead of starting a server.
./cc-backend --init-db --add-user <your-username>:admin:<your-password> --no-server ./cc-backend --init-db --add-user <your-username>:admin:<your-password>
# Start a HTTP server (HTTPS can be enabled, the default port is 8080): # Start a HTTP server (HTTPS can be enabled, the default port is 8080).
./cc-backend # The --dev flag enables GraphQL Playground (http://localhost:8080/playground) and Swagger UI (http://localhost:8080/swagger).
./cc-backend --server --dev
# Show other options: # Show other options:
./cc-backend --help ./cc-backend --help
@ -87,7 +82,7 @@ Having no jobs in the job-archive at all is fine.
### Configuration ### Configuration
A config file in the JSON format can be provided using `--config` to override the defaults. A config file in the JSON format has to be provided using `--config` to override the defaults.
By default, if there is a `config.json` file in the current directory of the `cc-backend` process, it will be loaded even without the `--config` flag. By default, if there is a `config.json` file in the current directory of the `cc-backend` process, it will be loaded even without the `--config` flag.
You find documentation of all supported configuration and command line options [here](./configs.README.md). You find documentation of all supported configuration and command line options [here](./configs.README.md).