这是一个用Typescript编写的nostr中继。
此实现已经可以用于生产环境。请参阅下面的支持功能。
项目主仓库可在GitHub上找到。
这里列出了具有中继特定实现的NIPs。
created_at
限制警告:从Snap、Brew或Debian仓库安装的Docker版本不受支持,会导致错误。 请仅从官方指南安装Docker。
开始之前
.env
文件.nostr/settings.yaml
文件中进行以下更改:
payments.enabled
设置为true
payments.feeSchedules.admission.enabled
设置为true
limits.event.pubkey.minBalance
设置为接受事件所需的最小余额(以毫聪为单位 )(例如,设置为1000000
要求1000聪的余额)zebedee
、nodeless
、opennode
、lnbits
、lnurl
.env
文件中设置ZEBEDEE_API_KEY
环境变量,使用上面的API密钥ZEBEDEE_API_KEY={在此处输入您的ZEBEDEE_API_KEY}
.nostr/settings.yaml
文件中进行以下更改:
payments.processor
改为 zebedee
paymentsProcessors.zebedee.callbackBaseURL
改为匹配你的 Nostream URL (例如 https://{你的域名}/callbacks/zebedee
)./scripts/stop
然后执行 ./scripts/start
)https://{你的域名}/callbacks/nodeless
),并确保启用所有事件。获取生成的商店 webhook 密钥NODELESS_API_KEY
和 NODELESS_WEBHOOK_SECRET
环境变量,分别使用生成的 API 密钥和 webhook 密钥NODELESS_API_KEY={你的NODELESS_API_KEY}
NODELESS_WEBHOOK_SECRET={你的NODELESS_WEBHOOK_SECRET}
.nostr/settings.yaml
文件中进行以下更改:
payments.processor
设置为 nodeless
paymentsProcessors.nodeless.storeId
设置为你的商店 ID./scripts/stop
然后执行 ./scripts/start
)完成"开始之前"的步骤
注册一个新账户并通过验证
前往 Developers > Integrations 设置两步验证
创建一个具有 Invoices 权限的新 API 密钥
在你的 .env
文件中设置 OPENNODE_API_KEY
环境变量
OPENNODE_API_KEY={你的OPENNODE_API_KEY}
在你的 .nostr/settings.yaml
文件中进行以下更改:
payments.processor
设置为 opennode
重启 Nostream (执行 ./scripts/stop
然后执行 ./scripts/start
)
完成"开始之前"的步骤
在你的公共 LNbits 实例上创建一个新钱包
获取钱包的 Invoice/read 密钥 (在钱包的 Api docs 部分)
在你的 .env
文件中设置 LNBITS_API_KEY
环境变量,使用上面的 Invoice/read 密钥
LNBITS_API_KEY={你的LNBITS_API_KEY}
在你的 .nostr/settings.yaml
文件中进行以下更改:
payments.processor
设置为 lnbits
lnbits.baseURL
设置为你的 LNbits 实例 URL (例如 https://{你的LNBITS域名}/
)paymentsProcessors.lnbits.callbackBaseURL
设置为匹配你的 Nostream URL (例如 https://{你的域名}/callbacks/lnbits
)重启 Nostream (执行 ./scripts/stop
然后执行 ./scripts/start
)
Alby 或任何支持 LNURL-verify 的 LNURL 提供商
.nostr/settings.yaml
文件中进行以下更改:
payments.processor
设置为 lnurl
lnurl.invoiceURL
设置为你的 LNURL (例如 https://getalby.com/lnurlp/your-username
)./scripts/stop
然后执行 ./scripts/start
)确保你的公钥需要支付
["REQ", "payment-test", {"authors":["你的十六进制公钥"]}]
按照官方指南安装 Docker。 如果你使用其他指南安装了 Docker,可能需要先卸载。
克隆仓库并进入目录:
git clone git@github.com:Cameri/nostream.git
cd nostream
生成一个密钥: openssl rand -hex 128
复制输出并粘贴到 .env
文件中:
SECRET=aaabbbccc...dddeeefff
# 密钥为简洁起见已缩短
启动:
./scripts/start
或
./scripts/start_with_tor
停止服务器:
./scripts/stop
打印 Tor 主机名:
./scripts/print_tor_hostname
默认情况下,此服务器将持续运行,直到你使用 Ctrl+C 停止它或系统重启。
如果你希望系统重启后服务器自动重新运行,可以安装为 systemd 服务。例如:
$ nano /etc/systemd/system/nostream.service
# 注意: 将 "User=..." 替换为你的用户名,
# "/home/nostr/nostream" 替换为你克隆仓库的目录。
[Unit]
Description=Nostr TS Relay
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=5
User=nostr
WorkingDirectory=/home/nostr/nostream
ExecStart=/home/nostr/nostream/scripts/start
ExecStop=/home/nostr/nostream/scripts/stop
[Install]
WantedBy=multi-user.target
然后:
systemctl enable nostream
systemctl start nostream
可以使用以下命令查看日志:
journalctl -u nostream
设置以下环境变量:
DB_URI="postgresql://postgres:postgres@localhost:5432/nostr_ts_relay_test"
DB_USER=postgres
或
DB_HOST=localhost
DB_PORT=5432
DB_NAME=nostr_ts_relay
DB_USER=postgres
DB_PASSWORD=postgres
REDIS_URI="redis://default:nostr_ts_relay@localhost:6379"
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_USER=default
REDIS_PASSWORD=nostr_ts_relay
生成一个长的随机密钥并设置 SECRET:
你可以使用 openssl rand -hex 128
来生成密钥。
SECRET=aaabbbccc...dddeeefff
# 密钥为简洁起见已缩短
创建 nostr_ts_relay
数据库:
$ psql -h $DB_HOST -p $DB_PORT -U $DB_USER -W
postgres=# create database nostr_ts_relay;
postgres=# quit
启动 Redis 并使用 redis-cli
设置默认密码并验证:
$ redis-cli
127.0.0.1:6379> CONFIG SET requirepass "nostr_ts_relay"
OK
127.0.0.1:6379> AUTH nostr_ts_relay
Ok
克隆仓库并进入目录:
git clone git@github.com:Cameri/nostream.git
cd nostream
安装依赖:
npm install -g knex
npm install
运行迁移(至少运行一次,并在拉取新更改后运行):
NODE_OPTIONS="-r dotenv/config" npm run db:migrate
在 nostream 项目文件夹内创建 .nostr 文件夹并复制设置文件:
mkdir .nostr
cp resources/default-settings.yaml .nostr/settings.yaml
以开发模式启动:
npm run dev
或者,以生产模式启动:
npm run start
清理构建、覆盖率和测试报告:
npm run clean
按照官方指南安装 Docker Desktop。 如果你按照其他指南安装了 Docker,可能需要先卸载它。