Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
update local relay configuration
add documentation links
add Dockerized Mostro info
  • Loading branch information
Catrya committed Dec 12, 2024
1 parent 3e5f7fa commit 16bb721
Showing 1 changed file with 29 additions and 8 deletions.
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Mostro will handle Bitcoin using a Lightning Network node, the node will create

Mostro will need a private key to be able to create, sign and send events through Nostr network.

In the next graphic we can see a very summarized version of how Mostro, the seller and the lightning node interact, a more detailed explanation can be found [here](https://mostro.network/messages):
In the next graphic we can see a very summarized version of how Mostro, the seller and the lightning node interact, a more detailed explanation can be found [here](https://mostro.network/protocol/):

```mermaid
sequenceDiagram
Expand Down Expand Up @@ -123,8 +123,8 @@ cargo run
### Option 1: Run Mostro with a private dockerized relay

```bash
cd relay
docker compose up -d
cd docker
docker compose up nostr-relay
```

This will spin a new docker container with an instance of [nostr-rs-relay](https://github.com/scsibug/nostr-rs-relay), that will listen at port `7000`.
Expand All @@ -136,20 +136,33 @@ relays = ['ws://localhost:7000']

#### Troubleshooting

If in the relay logs the error appears: `unable to open database file: /usr/src/app/db/nostr.db` you need to modify the docker-compose.yml file in the relay directory with:
If in the relay logs the error appears: `unable to open database file: /usr/src/app/db/nostr.db` you need to modify the `compose.yml` file in the `docker` directory with:

```yml
version: '3.8'

services:
mostro:
build:
context: ..
dockerfile: docker/Dockerfile
volumes:
- ./config:/config # settings.toml and mostro.db
platform: linux/amd64
networks:
- default

nostr-relay:
image: scsibug/nostr-rs-relay
container_name: nostr-relay
ports:
- '${MOSTRO_RELAY_LOCAL_PORT:-7000}:8080'
volumes:
- 'mostro_data:/usr/src/app/db:Z'
- './config.toml:/usr/src/app/config.toml:ro,Z'
- './config/relay/config.toml:/usr/src/app/config.toml:ro,Z'

networks:
default:
driver: bridge

volumes:
mostro_data:
```
Expand All @@ -158,6 +171,10 @@ volumes:
You just need to set `relays` in the `[nostr]` section of the `settings.toml` file with the relays you will use.

## Dockerized Mostro

If you want to run a dockerized version of Mostro, you can follow the step-by-step instructions in the [Docker Guide for MostroP2P](./docker/README.md).

## Contribute

You may be interested in contributing to Mostro. If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/MostroP2P/mostro/labels/good%20first%20issue) list.
Expand All @@ -168,6 +185,10 @@ More info in our [contributing guide](CONTRIBUTING.md).

To incentivize collaborators we have a **Rewards board**, we must clarify that Mostro is not a company but an open source project, the amounts offered are a way to thank for collaboration and we can offer it thanks to the generous donation of contributors, mostly anonymous, but also to two important institutions that have given us grants, you can check it [here](https://github.com/orgs/MostroP2P/projects/2/views/1).

## Documentation
- Protocol documentation: [https://mostro.network/protocol](https://mostro.network/protocol/)
- Frequently Asked Questions: in [English](https://mostro.network/docs-english/), in [Spanish](https://mostro.network/docs-spanish/).

## License

Mostro is licensed under the [MIT license](LICENSE).
Mostro is licensed under the [MIT license](LICENSE).

0 comments on commit 16bb721

Please sign in to comment.