nsite-plugin

A Woodpecker CI plugin to deploy nsites using the nsyte command-line tool.

To deploy a nsite, you must specify a Nostr secret key (or a nbunksec or bunker URL). You need to store it as a woodpecker secret in your project's CI settings.

Config

field	description
site	The directory of the website to deploy
relays	List of nostr relays URLs to publish to
servers	List of blossom servers URLs to upload to
nsec	Nostr signer secret (nsec, nbunksec, bunker URL, or 64-char hex)
use_config_file	Load settings from the .nsite/config.json file in the repository

Examples

Without a config file

Specifying relays and blossom servers, and using the nostr key from the NOSTR_KEY CI secret.

steps:
  - name: deploy
    image: codeberg.org/cipres/nsite-plugin:1
    settings:
      site: public
      relays:
        - wss://nos.lol
        - wss://nostr-pub.wellorder.net
      servers:
        - https://cdn.hzrd149.com
      nsec:
        from_secret: NOSTR_KEY

Using a config file

Install nsyte and create a nsite config file by running the nsyte init command and add the .nsite/config.json file to the git repository. Then, set the use_config_file setting in your workflow.

steps:
  - name: deploy
    image: codeberg.org/cipres/nsite-plugin:1
    settings:
      use_config_file: true
      site: public
      nsec:
        from_secret: NOSTR_KEY