Skip to content

Commit b41cff4

Browse files
committed
docs: add instructions for running local environment
1 parent e95d449 commit b41cff4

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@ NIPs with a relay-specific implementation are listed here.
7070

7171
### Docker setups
7272
- Docker v20.10
73-
- Docker compose v2.10
73+
- Docker Compose v2.10
74+
75+
### Local Docker setup
76+
- Docker Desktop v4.2.0 or newer
77+
- [mkcert](https://github.com/FiloSottile/mkcert)
7478

7579
WARNING: Docker distributions from Snap, Brew or Debian repositories are NOT SUPPORTED and will result in errors.
7680
Install Docker from their [official guide](https://docs.docker.com/engine/install/) ONLY.
@@ -79,6 +83,24 @@ Install Docker from their [official guide](https://docs.docker.com/engine/instal
7983

8084
- [Set up a Nostr relay in under 5 minutes](https://andreneves.xyz/p/set-up-a-nostr-relay-server-in-under) by [André Neves](https://twitter.com/andreneves) (CTO & Co-Founder At [ZEBEDEE](https://zebedee.io/))
8185

86+
## Local Quick Start (Docker Compose)
87+
88+
Install Docker Desktop following the [official guide](https://docs.docker.com/desktop/).
89+
You may have to uninstall Docker on your machine if you installed it using a different guide.
90+
91+
Clone repository and enter directory:
92+
```
93+
git clone [email protected]:Cameri/nostream.git
94+
cd nostream
95+
```
96+
97+
Start:
98+
```
99+
./scripts/start_local
100+
```
101+
102+
This will run in the foreground of the terminal until you stop it with Ctrl+C.
103+
82104
## Quick Start (Docker Compose)
83105

84106
Install Docker following the [official guide](https://docs.docker.com/engine/install/).

0 commit comments

Comments
 (0)