Skip to content

Commit

Permalink
doc: readme remove env
Browse files Browse the repository at this point in the history
  • Loading branch information
robot9706 committed Oct 11, 2023
1 parent 8406e36 commit c74b906
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Getting started

1. Enter `docker run -p 8000:8000 -p 5000:5000 -e AGENT_INSECURE=true --name darklens -d ghcr.io/dyrector-io/darklens:latest` in terminal
1. Enter `docker run -p 8000:8000 -p 5000:5000 --name darklens -d ghcr.io/dyrector-io/darklens:latest` in terminal
2. Open `localhost:8000` in browser
3. Enjoy!

Expand All @@ -28,27 +28,27 @@ Settings provides various configuration options for running darklens, tailor you

Launch Darklens without any authentication or authorization checks. Ideal for quick testing and development.

`docker run -p 8000:8000 -p 5000:5000 -e AGENT_INSECURE=true -e DISABLE_AUTH=true --name darklens -d ghcr.io/dyrector-io/darklens:latest`
`docker run -p 8000:8000 -p 5000:5000 -e DISABLE_AUTH=true --name darklens -d ghcr.io/dyrector-io/darklens:latest`

#### Select a stronger JWT secret

Enhance security by specifying a custom JWT secret for authentication.

`docker run -p 8000:8000 -p 5000:5000 -e AGENT_INSECURE=true -e JWT_SECRET=supersecret --name darklens -d ghcr.io/dyrector-io/darklens:latest`
`docker run -p 8000:8000 -p 5000:5000 -e JWT_SECRET=supersecret --name darklens -d ghcr.io/dyrector-io/darklens:latest`

#### Run on a public domain

Configure darklens to run on a public domain with options for specifying a public URL and agent address.

`docker run -p 8000:8000 -p 5000:5000 -e AGENT_INSECURE=true -e PUBLIC_URL=example.com AGENT_ADDRESS=example.com:5000 --name darklens -d ghcr.io/dyrector-io/darklens:latest`
`docker run -p 8000:8000 -p 5000:5000 -e PUBLIC_URL=example.com AGENT_ADDRESS=example.com:5000 --name darklens -d ghcr.io/dyrector-io/darklens:latest`

> Note: Agents require gRPC port 5000 to connect to the service
#### Persist data

Ensure data persistence by using Docker volumes to store Darklens data.

`docker run -p 8000:8000 -p 5000:5000 -e AGENT_INSECURE=true -v darklens-data:/var/lib/darklens --name darklens -d ghcr.io/dyrector-io/darklens:latest`
`docker run -p 8000:8000 -p 5000:5000 -v darklens-data:/var/lib/darklens --name darklens -d ghcr.io/dyrector-io/darklens:latest`

#### Use secure agents

Expand Down

0 comments on commit c74b906

Please sign in to comment.