relayable/strfry repository overview

⁠Overview

This is an unofficial Docker container of strfry⁠ nostr relay. The container is built to include nodejs and python3 for plugin development and testing. This container is maintained by npub1y3uh89v5a4vq92t8q0j6su94zhvcdxpywjn3l6hpsr5welarqtrqj7yzhd @jascha⁠. Please submit any bugs to the official Github repo. If a container related issue or feedback message me on nostr or strfry Telegram⁠.

This Docker image has nodejs and python3 added to make plugin development/testing easier.

⁠Examples

docker-compose.yml

services:
  strfry-nostr-relay:
    image: relayable/strfry:latest
    restart: unless-stopped
    volumes:
      - /local/path/to/strfry-data/etc:/etc/
      - /local/path/to/strfry-data/strfry-db:/app/strfry-db
      - /local/path/to/strfry-data/plugins:/app/plugins
    ports:
      - "7777:7777"

*If you wish for your strfry container to get its own internal network IP add network_mode: bridge under image section of compose file.

⁠Plugins

To use plugins drop yours into the plugins folder. Can use the example whitelist.js⁠ from strfry Github. Just add the whitelisted public hex keys of users you want to allow to use relay. Make sure whitelist.js is executable.

⁠Still need to run Nginx⁠ or Nginx Proxy Manager⁠ in front of strfry with SSL.

⁠Example Nginx config:

    server{
        server_name relay.yourdomain.com;
        location / {
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Host $host;
            proxy_pass http://127.0.0.1:7777;
            proxy_http_version 1.1;
            proxy_read_timeout 300s;
            proxy_connect_timeout 300s;
            proxy_send_timeout 300s;
            send_timeout 300s;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
        }
    }

More detailed howto for setting this up can be found here:
nostr note: note173ccjgyx0wyeg6vprmug6mlh0kucqdlr97at5mhhgv2g3f9xvdes4fw2l3
https://relayable.org/strfry-relay-howto.html⁠
https://write.bz/jascha/run-your-own-private-strfry-nostr-relay⁠

⁠Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.