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

Improve Readme file #395

Merged
merged 1 commit into from
Nov 19, 2024
+9 −3
Merged

Improve Readme file #395

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
SHELL := $(shell which bash)
docker-build:
@set -o pipefail; \
cd docker && \
Expand Down
11 changes: 8 additions & 3 deletions docker/DOCKER.md → docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,15 @@ To build and run the Docker container using Docker Compose, follow these steps:
git clone https://github.com/MostroP2P/mostro.git
```

2. Ensure you have the `settings.toml` configuration file and the `mostro.db` SQLite database in a `config` directory (acording to the `volumes` section). If you don't have those files from a previous installation, then the first time they will be created as follows:
2. Ensure you have the `settings.toml` configuration file and the `mostro.db` SQLite database in a `config` directory (acording to the `volumes` section in compose.yml file). If you don't have those files from a previous installation, then the first time they will be created as follows:

- `docker/config/settings.toml` from the `docker/settings.docker.toml` template
- `docker/config/mostro.db` from the `docker/empty.mostro.db` database
```sh
mkdir docker/config
cp docker/settings.docker.toml docker/config/settings.toml
cp docker/empty.mostro.db docker/config/mostro.db
```

_Don't forget to edit `lnd_grpc_host`, `nsec_privkey` and `relays` fields in the `config/settings.toml` file._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lnd_grpc_host and relays are intended to work as-is with polar and the included relay respectively. We should probably mention that.

The nsec_privkey needs to always be manually set.


3. Set the `LND_CERT_FILE` and `LND_MACAROON_FILE` to the paths of the LND TLS certificate and macaroon files on the `docker/.env` file. These files will be copied to the `docker/config/lnd` directory. For example:

Expand Down
Loading