https://github.com/quentintaranpino/nostrcheck-server
The community’s Nostr brain: The only server with relay, File Hosting (NIP-96 & Blossom), Nostr Address (NIP-05), Lightning Redirects, NWC, WoT, and much more.
https://github.com/quentintaranpino/nostrcheck-server
api blossom docker host invoice lightning-network media nip05 nip47 nip96 nip98 nostr nostraddress nostrwalletconnect nwc server typescript
Last synced: 5 days ago
JSON representation
The community’s Nostr brain: The only server with relay, File Hosting (NIP-96 & Blossom), Nostr Address (NIP-05), Lightning Redirects, NWC, WoT, and much more.
- Host: GitHub
- URL: https://github.com/quentintaranpino/nostrcheck-server
- Owner: quentintaranpino
- License: mit
- Created: 2023-05-08T07:34:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T11:12:00.000Z (9 days ago)
- Last Synced: 2025-05-01T12:24:09.234Z (9 days ago)
- Topics: api, blossom, docker, host, invoice, lightning-network, media, nip05, nip47, nip96, nip98, nostr, nostraddress, nostrwalletconnect, nwc, server, typescript
- Language: TypeScript
- Homepage: https://nostrcheck.me/api/v2
- Size: 5.07 MB
- Stars: 100
- Watchers: 6
- Forks: 19
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - nostrcheck-server - server.svg?style=social) - A server with relay, File Hosting, Nostr Address, Lightning Redirects, NWC and WoT. (Relays / Implementations)
README
# Nostrcheck server
## Powered by
        
 
## About
Nostrcheck Server is a comprehensive solution for managing and offering services within the Nostr ecosystem, designed to ensure data sovereignty. This server enables:
- **Nostraddress Management (NIP05):** Configure and manage personalized Nostr addresses.
- **Hosting of Multimedia Files:** Fully compatible with NIP94, NIP96, and Blossom🌸 for uploading and sharing content.
- **Lightning Redirects:** Allow your users to redirect payments to their Lightning wallets using their Nostraddress.
- **Full LN Integration:** Compatible with **Nostr Wallet Connect** and **LNBits**, enabling LN payments for file uploads, downloads, and user registrations.
- **Advanced User Management:** Control profiles, invitations, and permissions.
- **Plugin Module:** Customize and extend server functionalities with plugins. (WoT, etc).
- **Public Gallery and Directory:** The public gallery displays files uploaded by users, while the directory showcases user profiles from the community.
- **User-Managed Nostr Tools:** Users can manage their Nostr relays, profile data, uploaded files, and update their account settings directly from their profiles.
- **Ban Module:** Includes tools to ban users, ensuring data security and enabling the reporting of illegal activities to the authorities.
- **Integrated AI:** Automatically analyzes uploaded multimedia to detect sensitive or illegal content, reducing the workload for server administrators.
- **Invitation Module:** Allows administrators to manage invitation codes for controlled access to specific domains.
The server is highly customizable and can be deployed in any environment, allowing anyone to become a Nostr service provider.
## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Standalone Installation](#installation-standalone)
- [Docker Installation](#installation-docker)
- [Documentation](#documentation)
- [Configuration](#configuration)
- [Plugins](#plugins)
- [Screenshots](#screenshots)
- [Supported Nostr NIPs](#supported-nostr-nips)
- [Supported Blossom BUDs](#supported-blossom-buds)
- [Supported Lightning LUDs](#supported-lightning-luds)
- [Roadmap](#roadmap)
- [License](#license)
## Installation
The installation can be done in two ways, standalone where the system resources will be used natively and via docker where the software will be encapsulated in an isolated image.
The standalone installation allows you to configure more parameters, such as the database name, the public key of the server or other aspects. On the other hand, the docker installation is simpler and more secure, so use docker if you are not sure which one to choose.
In either case, all parameters can be modified using the settings page in the server administration panel.
### Installation (standalone)
To make a standalone installation you can use the following script. You can find the code [here](https://github.com/quentintaranpino/nostrcheck-api-ts/blob/main/scripts/install.sh)
```
curl https://raw.githubusercontent.com/quentintaranpino/nostrcheck-server/refs/heads/main/scripts/install.sh --output install.sh && chmod +x install.sh && ./install.sh
```
### Installation (docker)
To install and run the server using docker you can use the following script.
```bash
git clone https://github.com/quentintaranpino/nostrcheck-server.git && cd nostrcheck-server && sudo docker-compose up -d
```
[Video demonstration](https://github.com/quentintaranpino/nostrcheck-api-ts/assets/125748180/dff0933a-0325-4c0b-bad5-5e2702337ea0)
## Documentation
See documentation [here](https://github.com/quentintaranpino/nostrcheck-api-ts/blob/main/DOCS.md)
## Configuration
See configuration [here](https://github.com/quentintaranpino/nostrcheck-api-ts/blob/main/CONFIG.md)
## Plugins
See plugins [here](https://github.com/quentintaranpino/nostrcheck-api-ts/blob/main/PLUGINS.md)
## Screenshots
### Dashboard
### User public / private profile
### Nostr settings page
### Nostr relay management
### Nostr file manager
### Server settings page
### Login
### Gallery
### Uploads
### Directory
### Public API docs
### Customizable frontpage and logo
### Register form
### Payments (register)
### Payments (file hosting)
### Plugins
## Supported Nostr NIP's
- [x] NIP01
- [x] NIP04
- [x] NIP05
- [x] NIP07
- [x] NIP19
- [x] NIP44
- [x] NIP47
- [x] NIP94
- [x] NIP96
- [x] NIP98
## Supported Blossom BUD's
- [x] BUD01
- [x] BUD02
- [x] BUD03
- [x] BUD04
- [x] BUD06
- [x] BUD07
## Supported Lightning LUD's
- [x] LUD06
## Roadmap
- [x] Nostraddress service
- [x] Media uploads
- [x] Lightning redirects
- [x] Standalone Installation script
- [x] Docker installation
- [x] Nostr DM integration (NIP04)
- [x] Frontend UI (dashboard)
- [x] Frontend UI (settings)
- [x] Frontend UI (homepage)
- [x] Frontend UI (docs and ToS)
- [x] Remote Object Storage (s3)
- [x] Blossom spec compatible
- [x] Lightning payments
- [x] Frontend UI (profile)
- [x] Frontend UI (public gallery)
- [x] Frontend UI (public upload)
- [x] Frontend UI (register)
- [x] Ban system
- [x] AI moderation
- [x] Plugins engine
- [ ] Private Direct Messages (NIP17)
- [ ] Multi-server mirroring
- [ ] Import / Export data
- [ ] Custom frontend templates
- [x] Frontend UI (directory)
- [ ] Umbrel appstore integration
- [ ] Start9 appstore integration
- [ ] Integrated micro-relay
- [x] Nostr wallet connect
## License
MIT License (MIT)
```text
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```