Skip to content

Commit e5fdd91

Browse files
committed
readme stuff
1 parent a8beb13 commit e5fdd91

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,16 @@ cd rssnotes
4444
- **RANDOM_SECRET** --- This is used to generate the nostr public/private keys for the rss feeds. This should be a randomly generated string at least 20 characters long.
4545
- **RELAY_URL** --- the URL of your relay ex.: myrssrelay.com. This is only used for display on the relay's main page. It does not affect your relays actual URL.
4646

47-
9. Save and exit the `.env` file.
47+
9. The remaining variables in the `.env` file are optional. Save and exit the `.env` file.
4848

4949
10. Create a file called `seedrelays.json`.
5050

5151
11. Copy and paste the contents from the [sample.seedrelays.json](https://github.com/trinidz/rssnotes/blob/main/sample.seedrelays.json) file into your `seedrelays.json` file. Save and exit the file.
5252

5353
12. Run `docker-compose up -d` while in the `rssnotes` directory. This will start the rssnotes container in the background.
5454

55+
12. Go to http://localhost:3334 in your browser.
56+
5557
## Run the relay as a service on your system
5658
1. Clone the repo and cd into the repo folder.
5759
```bash
@@ -74,8 +76,8 @@ cp sample.seedrelays.json seedrelays.json
7476
4. Open the .env file and add values for the following REQUIRED environment variables.
7577
- **RELAY_PRIVKEY** --- Use a nostr key generator to create a new set of nostr private and public keys for the relay. DO NOT USE your own existing nostr keys. The relay will use these keys to follow all of your rss feeds and for other background tasks.
7678
- **RELAY_PUBKEY** --- acquired from the new private key created above.
77-
- **RELAY_URL** --- the URL of your relay ex.: myrssrelay.com. This is only used for display on the relay's main page. It does not affect your relays actual URL.
7879
- **RANDOM_SECRET** --- This is used to generate the nostr public/private keys for the rss feeds. This should be a randomly generated string at least 20 characters long.
80+
- **RELAY_URL** --- the URL of your relay ex.: myrssrelay.com. This is only used for display on the relay's main page. It does not affect your relays actual URL.
7981

8082
5. The remaining variables in the .env file are optional.
8183

0 commit comments

Comments
 (0)