fix
This commit is contained in:
parent
acba2ae01e
commit
9925d089d5
1 changed files with 46 additions and 41 deletions
15
README.md
15
README.md
|
@ -5,8 +5,7 @@
|
|||
<h1>NIP-42 Proxy</h1>
|
||||
<p>A NIP-42 authentication proxy for Nostr relays.</p>
|
||||
<p>
|
||||
<a href="https://hub.docker.com/r/your-docker-repo/nip42-proxy"><img src="https://img.shields.io/docker/pulls/your-docker-repo/nip42-proxy.svg" alt="Docker Pulls"></a>
|
||||
<a href="https://www.bunity.com/"><img src="https://img.shields.io/badge/bun-%23FBF0DF.svg?style=for-the-badge&logo=bun&logoColor=black" alt="Bun"></a>
|
||||
<a href="https://www.bun.sh/"><img src="https://img.shields.io/badge/bun-%23FBF0DF.svg" alt="Bun"></a>
|
||||
<a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
|
||||
</p>
|
||||
</td>
|
||||
|
@ -36,29 +35,34 @@ This project provides a robust NIP-42 proxy for Nostr relays, creating an authen
|
|||
### Installation & Running
|
||||
|
||||
1. **Clone the repository:**
|
||||
|
||||
```bash
|
||||
git clone https://git.arx-ccn.com/Arx/nip42-proxy.git
|
||||
cd nip42-proxy
|
||||
```
|
||||
|
||||
2. **Install dependencies:**
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
3. **Run the proxy:**
|
||||
- **With Bun:**
|
||||
|
||||
* **With Bun:**
|
||||
```bash
|
||||
RELAY_URL="wss://my-relay.com" ADMIN_PUBKEY="my-admin-pubkey" bun run index.ts
|
||||
```
|
||||
|
||||
* **With Docker:**
|
||||
- **With Docker:**
|
||||
1. Build the image:
|
||||
|
||||
```bash
|
||||
docker build -t nip42-proxy .
|
||||
```
|
||||
|
||||
2. Run the container:
|
||||
|
||||
```bash
|
||||
docker run -p 3000:3000 -e RELAY_URL="wss://your-relay-url.com" -e ADMIN_PUBKEY="my-admin-pubkey" --name nip42-proxy nip42-proxy
|
||||
```
|
||||
|
@ -73,7 +77,7 @@ The proxy is configured through environment variables.
|
|||
<summary>Click to view all configuration options</summary>
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ----------------------- | ------------------------------------------------------------------------------------------------------- | --------- |
|
||||
| ------------------------ | ----------------------------------------------------------------- | ----------- |
|
||||
| `ALLOW_UNAUTHED_PUBLISH` | Set to `true` to allow unauthenticated clients to publish events. | `false` |
|
||||
| `RELAY_URL` | The URL of the relay that the proxy will connect to. | |
|
||||
| `RELAY_OUTSIDE_URL` | The URL that clients use to connect to the proxy. | `RELAY_URL` |
|
||||
|
@ -117,3 +121,4 @@ Contributions are welcome! Please open an issue or submit a pull request with yo
|
|||
## 📄 License
|
||||
|
||||
This project is licensed under the AGPLv3. See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue