localstrfry is an example project aimed at demonstrating how to set up and customize a local instance of the strfry relay for the Nostr network using Docker. This project serves as a practical resource for developers and enthusiasts interested in exploring relay customization in a local environment, particularly for those involved with Nostr, a decentralized social network. The setup showcases the integration of Traefik and Nginx for effective service routing and redirection.
- Docker and Docker Compose installed on your machine.
- Basic familiarity with Docker concepts, and Traefik and Nginx configuration.
-
Clone the Repository:
git clone https://github.com/planetary-social/localstrfry.git
-
Navigate to the Project Directory:
cd localstrfry -
Start the Relay using Docker Compose:
- This command downloads necessary images and starts the services defined in the `docker-compose.yml` file.
docker-compose up
-
Accessing the Custom HTML Page:
- Visit `http://localhost\` to access a custom HTML page, which differs from the default strfry relay page. This page is served by the `redirect-service`, demonstrating the usage of Nginx for content redirection.
To secure your relay with SSL/TLS, follow the Traefik HTTPS setup instructions. This involves configuring Traefik with a certificate resolver for automatic SSL certificate generation and renewal, making your relay suitable for a more secure, production-oriented environment.
Contributions to localstrfry are welcome. If you have ideas for improvements or additional features, please follow the standard GitHub pull request process.
This project is licensed under the MIT License - see the LICENSE file for details.