i'm an account example No.3

NOSTR group account publisher

i'm an account example No.3 — Thu, 02 Oct 2025 10:58:24 GMT

NOSTR group account publisher

This is a small project to describe a group or organization or institution via text files.
This description can be transform to NOSTR events and published over relays. It can be used to initially set up a NOSTR account.
Details about the structure and the different kinds of Information you can provide via NOSTR can be looked up in the doc folder.

A command line tool to bootstrap a NOSTR account, for example if you want to move your stuff from a proprietary platform over to NOSTR, just as a mirror.

define the profile

A profile is described by a YAML file and define your group/profile content.
When you want to use the long form format you need to store the text in markdown in a directory and supply the program with the --articlePath Parameter.

You find examples in the directory profileExamples/ also described in the examples doc.

supported content

profil meta data
- follow List Kind:3
- relay list kind:10002
- interrests kind:10015
- pin list kind:10001
short Note Kind:1
long Note Kind:30023
Calendar Kind:31924
Calendar Events Kind:31923
bookmark set Kind:30003
curation set Kind:30004
interrest set Kind:30015
follow set Kind:30000
mute set Kind:30007
starter pack Kind:39089



classDiagram

    %% ---------- Hauptklassen ----------
    class NostrSet {
        -String dTag
        -String title
        -String imageUrl
        -String summary
        -List kind1
        -List kind30023
        -List tags
        -List urls
        -List profiles
        -Long createdAt
    }


    class Media {
        -String title
        -String imageUrl
        -String summary
        -Long createdAt
        -Long duration
        -String contentWarning
        -List imeta
    }


    class NostrResource {
        -String url
        -String mimeType
        -String hash
        -String orgHash
        -Long size
        -String dim
        -String magnetLink
        -String torrent
        -String blurhash
        -String thumb
        -String image
        -String summary
        -String alt
        -List fallback
        -String service
    }

    class Profile {
        -String pk
        -Map metadata
        -List nip39
        -List kind3
        -List kind10002
        -List kind10015
        -List kind1
        -List kind30023
        -List kind10001
        -List kind30003
        -List kind30004
        -List kind30015
        -List kind30000
        -List kind30007
        -List kind39089
        -List kind31924
        -List kind31923
        -List kind20
    }

    %% ---------- Weitere Klassen (nur Referenz) ----------
    class ForainId {
        - String user;
        - String proof;

    }
    class NostrId {
    - String publicKey;
    - String relay;
    - String petname;
    }
    class Relay {
        - String name;
        - String url;
        - boolean write;

    }
    class Note {
    - String content;
    - List tags;
    - Long createdAt;

    }
    class Article {
    - String dTag;
    - String file;
    - String title;
    - String imageUrl;
    - String summary;
    - List tags;
    - Long createdAt;
    }
    class Calendar {
    - String dTag;
    - String summary;
    - String title;
    - String imageUrl;
    - List includedCaledarEvents;
    - Long createdAt;
    }
    class CalendarEvent {
    - String dTag;
    - String title;
    - String summary;
    - String imageUrl;
    - String startTzid;
    - String endTzid;
    - String location;
    - String geoHash;
    - Long start;
    - Long end;
    - Long createdAt;

    }

    %% ---------- Beziehungen ----------
    Profile "1" o-- "*" NostrSet : kind30003/04/05/... 
    Profile "1" o-- "*" Media : kind20
    Profile "1" o-- "*" NostrId : kind3
    Profile "1" o-- "*" Note : kind1
    Profile "1" o-- "*" Article : kind30023
    Profile "1" o-- "*" Calendar : kind31924
    Profile "1" o-- "*" CalendarEvent : kind31923
    Profile "1" o-- "*" ForainId : nip39
    Profile "1" o-- "*" Relay : kind10002
    Media "1" o-- "*" NostrResource : imeta

supported signer

NoSigner
NOSTR Sign device https://nsd.lnbits.com/
nsec

prepare the content

You define the yaml content.
see the 'profileExamples' for more details the 'group-example' is this application it self and klarmachen an old blog of mine

profile data
content
- text notes
- articles
- calendar
- following
media data - you need to store all the media on a hoster as NOSTR only serve json
- own hoster
- cloud service
  - anonymous hosting via lightning
    - https://satellite.earth/cdn

Articles should be in markdown files, in one directory, defined by their yaml values.
You can organize the content further in lists (bookmarsets) where you references notes, articles etc.

prepare the identity

NOSTR uses private public key management, you can create an account out of math.
When you want to create an institutional group, you should use a hardware device to manage the account, shared secrets are not rally a secret. The signing device allows to share the key without compromising it. In an institution people changes but institutional accounts should not.

Transferring the device can be part of the institutional transition process and should be formalized in the constitution if the organization has one.

currently supported is:

https://github.com/lnbits/nostr-signing-device

usage

first build:

./gradlew build

after you find in /nostr-account-publisher/application/build/distributions the zip.
Which contains a simple bash script to start the application.

Usage: profileCreator [-hs] [-a=] [-m=] [-o=]
                    -p= [--portHint=]
                    [--privateKey=]
Create a NOSTR profile from a YAML configuration.
-a, --articlePath=
                            the complete path to the article directory
-h, --help                display this help message
-m, --method= The method to sign the events. Valid values: NO,
                            PK, HDW
                            Default: NO
-o, --outPath=   path to store the event json
-p, --profileYaml=
                            the complete path to a yaml which describes the
                            profile
    --portHint= a hint to find the com port
                            Default: ACM
    --privateKey=
                            The private key as hex, valid only with the option
                            --method PK.
-s, --sendEvents          publish the events to relays
                            Default: false

You can store the generated event json to file by supplying the -o parameter, use this for dry runs where you can check the data and the structure.
Single objects get a simple name, while objects in lists, like notes and articles are name by their Event Kind and the index in the list, like 23_1.json.

You can also keep them to republish to other relays or as a backup. As the events are signed, all it takes is to transmit them again.

NOSTR-Account-Publisher

i'm an account example No.3 — Thu, 02 Oct 2025 10:58:24 GMT

NOSTR-Account-Publisher

Dies ist ein kleines Projekt, um eine Gruppe, Organisation oder Institution über Textdateien zu beschreiben.
Diese Beschreibung kann in NOSTR-Ereignisse umgewandelt und über Relays veröffentlicht werden. Sie kann zum Einrichten eines NOSTR-Kontos verwendet werden.
Details zur Struktur und zu den verschiedenen Arten von Informationen, die Sie über NOSTR bereitstellen können, finden Sie im Ordner „doc”.

Ein Befehlszeilentool zum Einrichten eines NOSTR-Kontos, beispielsweise wenn Sie Ihre Daten von einer proprietären Plattform auf NOSTR übertragen möchten, beispielsweise als Spiegel.

Definieren Sie das Profil

Ein Profil wird durch eine YAML-Datei beschrieben und definiert den Inhalt Ihrer Gruppe/Ihres Profils.
Wenn Sie das Langformat verwenden möchten, müssen Sie den Text in Markdown in einem Verzeichnis speichern und dem Programm den Parameter --articlePath übergeben.

Beispiele finden Sie im Verzeichnis profileExamples/, das auch in der Beispiel-Dokumentation beschrieben ist.

Unterstützte Inhalte

Profil-Metadaten
- Follow-Liste kind:3
- Relay-Liste kind:10002
- Interessen kind:10015
- Pin-Liste kind:10001
Kurze Notiz kind:1
Lange Notiz kind:30023
Kalender kind:31924
Kalenderereignisse kind:31923
Lesezeichensatz kind:30003
Kurationssatz kind:30004
Interessenssatz kind:30015
Follow-satz kind:30000
Stummschaltungssatz kind:30007
Starterpaket kind:39089


classDiagram
direction TB
    class NostrSet {
        -String dTag
        -String title
        -String imageUrl
        -String summary
        -List kind1
        -List kind30023
        -List tags
        -List urls
        -List profiles
        -Long createdAt
    }
    class Media {
        -String title
        -String imageUrl
        -String summary
        -Long createdAt
        -Long duration
        -String contentWarning
        -List imeta
    }
    class NostrResource {
        -String url
        -String mimeType
        -String hash
        -String orgHash
        -Long size
        -String dim
        -String magnetLink
        -String torrent
        -String blurhash
        -String thumb
        -String image
        -String summary
        -String alt
        -List fallback
        -String service
    }
    class Profile {
        -String pk
        -Map metadata
        -List nip39
        -List kind3
        -List kind10002
        -List kind10015
        -List kind1
        -List kind30023
        -List kind10001
        -List kind30003
        -List kind30004
        -List kind30015
        -List kind30000
        -List kind30007
        -List kind39089
        -List kind31924
        -List kind31923
        -List kind20
    }
    class ForainId {
        - String user;
        - String proof;
    }
    class NostrId {
        - String publicKey;
        - String relay;
        - String petname;
    }
    class Relay {
        - String name;
        - String url;
        - boolean write;
    }
    class Note {
        - String content;
        - List tags;
        - Long createdAt;
    }
    class Article {
        - String dTag;
        - String file;
        - String title;
        - String imageUrl;
        - String summary;
        - List tags;
        - Long createdAt;
    }
    class Calendar {
        - String dTag;
        - String summary;
        - String title;
        - String imageUrl;
        - List includedCaledarEvents;
        - Long createdAt;
    }
    class CalendarEvent {
        - String dTag;
        - String title;
        - String summary;
        - String imageUrl;
        - String startTzid;
        - String endTzid;
        - String location;
        - String geoHash;
        - Long start;
        - Long end;
        - Long createdAt;
    }
    

    note for Note "The short Note."
    note for Article "The long Note."
    note for NostrSet "A named List for different content."
    note for Profile "The configuration of the account."

    Profile "1" o-- "*" NostrSet : kind30003/04/05/...
    Profile "1" o-- "*" Media : kind20
    Profile "1" o-- "*" NostrId : kind3
    Profile "1" o-- "*" Note : kind1
    Profile "1" o-- "*" Article : kind30023
    Profile "1" o-- "*" Calendar : kind31924
    Profile "1" o-- "*" CalendarEvent : kind31923
    Profile "1" o-- "*" ForainId : nip39
    Profile "1" o-- "*" Relay : kind10002
    Media "1" o-- "*" NostrResource : imeta
    NostrSet "1" o-- "*" Note : kind1
    NostrSet "1" o-- "*" Article : kind30023
    NostrSet "1" o-- "*" NostrId : profiles
    Calendar "1" o-- "*" CalendarEvent : includedCaledarEvents

Unterstützte Signaturdienste

NoSigner
NOSTR Signaturgerät https://nsd.lnbits.com/
nsec

Inhalt vorbereiten

Sie definieren den YAML-Inhalt.
Weitere Details finden Sie unter „profileExamples”. Das „group-example” ist diese Anwendung selbst und klarmachen, ein alter Blog von mir.

Profildaten
Inhalt
- Textnotizen
- Artikel
- Kalender
- Following
Mediendaten – Sie müssen alle Medien auf einem Hoster speichern, da NOSTR nur JSON bereitstellt.
- Eigener Hoster
- Cloud-Dienst
  - Anonymes Hosting über Lightning
    - https://satellite.earth/cdn

Artikel sollten in Markdown-Dateien in einem Verzeichnis gespeichert werden, das durch ihre YAML-Werte definiert ist.
Sie können die Inhalte weiter in Listen (Bookmarksets) organisieren, in denen Sie auf Notizen, Artikel usw. verweisen.

Identität vorbereiten

NOSTR verwendet die Verwaltung privater und öffentlicher Schlüssel. Sie können ein Konto aus mathematischen Daten erstellen.
Wenn Sie eine institutionelle Gruppe erstellen möchten, sollten Sie ein Hardwaregerät zur Verwaltung des Kontos verwenden, da gemeinsam genutzte Geheimnisse nicht wirklich geheim sind. Das Signaturgerät ermöglicht es, den Schlüssel zu teilen, ohne ihn zu gefährden. In einer Institution wechseln die Mitarbeiter, institutionelle Konten sollten dies jedoch nicht.

Die Übertragung des Geräts kann Teil des institutionellen Übergangsprozesses sein und sollte in der Satzung formalisiert werden, falls die Organisation über eine solche verfügt.

Derzeit wird Folgendes unterstützt:

https://github.com/lnbits/nostr-signing-device

Verwendung

Erste Erstellung:

./gradlew build

Nachdem Sie die ZIP-Datei in /nostr-account-publisher/application/build/distributions gefunden haben.
Diese enthält ein einfaches Bash-Skript zum Starten der Anwendung.

Verwendung: profileCreator [-hs] [-a=] [-m=] [-o=]
                    -p= [--portHint=]
                    [--privateKey=]
Erstellt ein NOSTR-Profil aus einer YAML-Konfiguration.
-a, --articlePath=
                            Der vollständige Pfad zum Artikelverzeichnis.
-h, --help                Zeigt diese Hilfe an.
-m, --method= Die Methode zum Signieren der Ereignisse. Gültige Werte: NO,
                            PK, HDW
                            Standard: NO
-o, --outPath=   Pfad zum Speichern der Ereignis-JSON-Datei
-p, --profileYaml=
                            Der vollständige Pfad zu einer YAML-Datei, die das
                            Profil beschreibt
    --portHint= Ein Hinweis zum Auffinden des COM-Ports
                            Standard: ACM
    --privateKey=
                            Der private Schlüssel als Hexadezimalwert, nur gültig mit der Option
                            --method PK.
-s, --sendEvents          Veröffentlicht die Ereignisse an Relais
                            Standard: false

Sie können die generierte Ereignis-JSON-Datei mit dem Parameter -o in einer Datei speichern. Verwenden Sie dies für Probeläufe, bei denen Sie die Daten und die Struktur überprüfen können.
Einzelne Objekte erhalten einen einfachen Namen, während Objekte in Listen, wie Notizen und Artikel, nach ihrer Ereignisart und dem Index in der Liste benannt werden, z. B. 1_1.json.

Sie können sie auch aufbewahren, um sie erneut an andere Relays zu senden oder als Backup zu verwenden. Da die Ereignisse signiert sind, müssen sie lediglich erneut übertragen werden.