verita84/posterstrudel
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README.md
Some checks are pending
Docker image / build-and-push-image (push) Waiting to run
Details

Browse Source
This commit is contained in:
verita84 2024-09-17 18:16:47 -06:00
parent fe3bed037e
commit 3b7c892b39
1 changed files with 1 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -22,27 +22,11 @@ While logging in with a secret key is supported. please don't. This is a web cli
I would recommend you use a browser extension like [Alby](https://getalby.com/) or [Nos2x](https://github.com/fiatjaf/nos2x) I would recommend you use a browser extension like [Alby](https://getalby.com/) or [Nos2x](https://github.com/fiatjaf/nos2x)
## Running with docker
```bash
docker run --rm -p 8080:80 ghcr.io/hzrd149/nostrudel:master
```
## Docker compose and other services
noStrudels docker image has a few options for connecting to other services running locally
- `CACHE_RELAY`: if set the client will use the relay to cache all of its events instead of storing them in the browser cache
- `IMAGE_PROXY`: can be set to a local [imageproxy](https://github.com/willnorris/imageproxy) instance so the app can resize profile images
- `REQUEST_PROXY`: can be set to a local [cors-anywhere](https://github.com/Rob--W/cors-anywhere) instance so the app can proxy http request
- `PROXY_FIRST`: if this is set to `true` all http requests will go through the request proxy first
You can find a full example of all these services in the [docker-compose.yaml](./docker-compose.yaml)
## Running locally ## Running locally
```bash ```bash
git clone git@github.com:hzrd149/nostrudel.git git clone https://git.poster.place/verita84/posterstrudel
cd nostrudel cd nostrudel
yarn install yarn install
yarn dev yarn dev