MostroP2P / mostro

Lightning Network peer-to-peer exchange platform on Nostr
https://mostro.network
MIT License
191 stars 32 forks source link

feat(docker): unify mostro and relay compose #392

Closed jgmontoya closed 2 weeks ago

jgmontoya commented 2 weeks ago

This also improves the Dockerfile.

There is still some work to be done, but getting started with mostro now should be easier: if you already have a polar network/lnd-node set up:

git clone https://github.com/MostroP2P/mostro.git
# Create docker/.env with proper values
make docker-build
# Copy your settings.toml on docker/config/settings.toml, if not then one will be created for you but you'll need to fill your nsec later
make docker-up

This will spin up a relay and the mostro instance pointing to that relay, it will copy the LND cert file and macaroon file and allow communicating with the running polar node.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request involve modifications to various configuration and build files for a Docker-based application. Key updates include adjustments to the .gitignore file to manage ignored directories, enhancements to the Makefile for Docker operations, and updates to the Docker environment configuration. Additionally, the Dockerfile and Docker Compose configurations have been revised to improve the build process and service management. Documentation has been updated to reflect these changes, providing clearer instructions for users.

Changes

File Change Summary
.gitignore Removed entry for /relay/data/*, added entry for docker/config, added comment header for clarity.
Makefile Added targets: docker-build, docker-up, docker-relay-up, docker-down for managing Docker services.
docker/.env.example Added variables: LND_CERT_FILE, LND_MACAROON_FILE, MOSTRO_RELAY_LOCAL_PORT.
docker/DOCKER.md Updated documentation for Docker setup, including prerequisites and configuration details.
docker/Dockerfile Updated Rust version to 1.82, added build dependencies, modified working directory, changed entry point.
docker/compose.yml Added nostr-relay service, updated mostro service with networks section, removed LND volume mapping.
docker/relay_config.toml Uncommented secret_key configuration option.
docker/settings.docker.toml Updated LND file paths and modified Nostr relay list.
relay/.env.example Removed file containing MOSTRO_RELAY_LOCAL_PORT variable.
relay/docker-compose.yml Removed file defining nostr-relay service configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docker
    participant NostrRelay
    participant LND

    User->>Docker: Run docker-compose up
    Docker->>NostrRelay: Start Nostr relay service
    Docker->>LND: Ensure LND service is running
    NostrRelay->>User: Relay service is active

🐰 "In the land of code, where rabbits play,
New Docker paths brighten the way.
With builds and services, all in a row,
Our MostroP2P will surely glow!
So hop along, let’s cheer and sing,
For changes made, oh what joy they bring!" 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.