Skip to content

Commit

Permalink
Update docker install info
Browse files Browse the repository at this point in the history
  • Loading branch information
ohsayan committed Dec 5, 2023
1 parent bbfcd82 commit cdd5e73
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,17 @@ The package will:
3. **Start the container**:
```shell
docker run -d --name skydb \
-v /home/docker-containers/skytable:/var/skytable \
-v /home/docker-containers/skytable:/var/lib/skytable \
-p 2003:2003 \
-e SKYDB_AUTH_ROOT_PASSWORD=<your root password> \
-e SKYDB_AUTH_PLUGIN=pwd skytable/skytable:latest
skytable/skytable:latest
```
**Replace with your own secure password!**

Explanation:
- This starts a container with name `skydb`
- It maps the folder (as discussed earlier) `/home/docker-containers/skytable` from your local file system to `/var/skytable` (in the container's file system)
- Maps port `2003` on the host to the containers port `2003` so that you can use the command-line client `skysh` without having to inspect the container's IP address
- Set's some basic configuration:
- `SKYDB_AUTH_ROOT_PASSWORD`: sets the root password. you can't use Skytable without a `root` account
- `SKYDB_AUTH_PLUGIN`: this sets the authentication plugin to `pwd` which is the simplest authentication plugin

:::tip
The password for the Skytable instance on the Docker container is auto-generated Run `docker logs -f skydb` and you'll see a log
message with the generated password.
:::

0 comments on commit cdd5e73

Please sign in to comment.