https://github.com/ngerakines/atproto-nodeinfo-gen

Generate well-known nodeinfo files for an ATProtocol PDS.
https://github.com/ngerakines/atproto-nodeinfo-gen

atprotocol well-known

Last synced: 7 days ago
JSON representation

Generate well-known nodeinfo files for an ATProtocol PDS.

• Host: GitHub
• URL: https://github.com/ngerakines/atproto-nodeinfo-gen
• Owner: ngerakines
• Created: 2024-09-11T15:18:53.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T15:45:01.000Z (4 months ago)
• Last Synced: 2025-01-03T12:45:05.106Z (8 days ago)
• Topics: atprotocol, well-known
• Language: Python
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# atproto-nodeinfo-gen

A tool to generate well-known nodeinfo files for atprotocol servers.

# Usage

    usage: atproto-nodeinfo-gen [-h] [-n NAME] [-d DESCRIPTION] [-o OUT] hostname

    

    Generate a well-known nodeinfo file for a PDS.

    

    positional arguments:

      hostname              The hostname of the PDS to generate the file for.

    

    options:

      -h, --help            show this help message and exit

      -n NAME, --name NAME  The name of the PDS.

      -d DESCRIPTION, --description DESCRIPTION

                            The description of the PDS.

      -o OUT, --out OUT     The destination that the well-known data is written to.

Direct CLI:

    $ atproto-nodeinfo-gen -n "My PDS" -d "A PDS for my project" -o /path/to/your/pds/.well-known/nodeinfo my-pds.example.com

Docker:

    $ docker run --rm -v /path/to/your/www/.well-known/:/out ghcr.io/github/atproto-nodeinfo-gen:latest -n "My PDS" -d "A PDS for my project" -o /out/nodeinfo my-pds.example.com

# Deployment

The easiest thing to do is to run the container every 30 minutes using a crontab entry like:

    0,30 * * * * docker run -v /path/to/your/www/.well-known/:/out/ ghcr.io/ngerakines/atproto-nodeinfo-gen:latest my-pds.example.com -o /out/nodeinfo

# Container

The container is built and published to the GitHub Container Registry (ghcr.io/github/atproto-nodeinfo-gen:latest) on every push to the main branch.