Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Docker Compose snippet to examples #891

Closed
wants to merge 1 commit into from
Closed

Add Docker Compose snippet to examples #891

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,23 @@ $ docker run --name hsd \
--api-key=foo
```

If using Docker Compose, the `hsd` service should look something like this:

```yaml
services:
hsd:
image: ghcr.io/handshake-org/hsd:latest
restart: unless-stopped
container_name: hsd
volumes:
- $HOME/.hsd:/root/.hsd
ports:
- 12037:12037
command: >
--http-host=0.0.0.0
--api-key=foo
```

To test connectivity, curl the info endpoint:
```bash
$ curl http://x:foo@localhost:12037/
Expand All @@ -138,3 +155,8 @@ To stop a container named `hsd`, run:
$ docker stop hsd
```

If using Docker Compose, run:

```bash
docker compose stop hsd
```