Skip to content

Latest commit

 

History

History

zapoli

README.md

zapoli

A Specialized Nostr Relay For AppStores


Zapoli is a purpose-built Nostr relay designed for projects like ZapStore. It provides BlobStore and management (NIP-86) and implements robust access control mechanisms, allowing pubkeys to be explicitly allowed or banned.

Screenshot

zapoli

Features

  • BlobStore Support: Enables efficient storage and retrieval of blobs.
  • Management(NIP-86): Allow or ban pubkeys to manage relay participation.
  • NIP-50: Search: Allow searching softwares.

Installation

Setup

Here's an adapted Setup section considering that you'll push the base image to Docker Registry, allowing users to pull and run it easily.

Installation

Setup

Option 1: Use Prebuilt Docker Image (Recommended)

The easiest way to run Zapoli is by using the prebuilt image:

  1. Pull the latest image

    docker pull dezhtech/zapoli

  2. Run Zapoli with environment variables

    docker run -d --name zapoli \
-p 3334:3334 \
-e RELAY_NAME="zapoli" \
-e RELAY_PUBKEY="your_pubkey" \
-e RELAY_DESCRIPTION="Specialized Nostr Relay For AppStores" \
-e RELAY_URL="wss://jellyfish.land" \
-e RELAY_ICON="https://your-icon-url.png" \
-e RELAY_BANNER="https://your-banner-url.png" \
-e RELAY_CONTACT="https://dezh.tech" \
-e WORKING_DIR="zapoli_wd/" \
-e RELAY_PORT=":3334" \
-e ADMIN_PUBKEYS="" \
dezhtech/zapoli

Option 2: Using Docker Compose

For a more structured deployment, use Docker Compose:

  1. use compose.yml use the exist compose file in the zapoli directory

  2. Run with Compose

    docker-compose up -d

Configuration

Modify the env variables in .env file, docker compose file or docker command to customize settings:

Relay Metadata

  • RELAY_NAME – The name of the relay (default: zapoli).
  • RELAY_PUBKEY – The owner's hex key (convert npub to hex here).
  • RELAY_DESCRIPTION – A short description of the relay.
  • RELAY_URL – WebSocket URL for the relay (e.g., wss://abc.com).
  • RELAY_ICON – URL to the relay's icon.
  • RELAY_BANNER – URL to the relay's banner image.
  • RELAY_CONTACT – Contact URL (e.g., https://dezh.tech).

Storage & Working Directory

  • WORKING_DIR – Configuration working directory (default: zapoli_wd).

Networking & Ports

  • RELAY_PORT – Port on which the relay listens (default: :3334).

Admin Access Control

  • ADMIN_PUBKEYS – Comma-separated list of allowed public keys.

Contributing

Pull requests are welcome! Feel free to open an issue if you have feature requests or find bugs.

License

This software is published under MIT License.