Nostrcheck server

Powered by

About

Nostrcheck server is a set of tools to interact with nostr and be sovereign of your data.

It allows to validate nostr address (NIP05), multimedia uploads (NIP94, NIP96), nostr notes integrity check and lightning redirects. All under NIP98 authentication 100% nostr compatible.

The server can be installed anywhere and allows anyone to become a nostr service provider.

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

curl https://raw.githubusercontent.com/quentintaranpino/nostrcheck-api-ts/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.

git clone https://github.com/quentintaranpino/nostrcheck-api-ts.git && cd nostrcheck-api-ts && sudo docker-compose up -d --build

https://github.com/quentintaranpino/nostrcheck-api-ts/assets/125748180/dff0933a-0325-4c0b-bad5-5e2702337ea0

Documentation

See documentation here

Configuration

See configuration here

Screenshots

Dashboard

User public / private profile

Server settings page

Login

Public API docs

Customizable frontpage and logo

Supported nips

• [x] NIP01
• [x] NIP04
• [x] NIP05
• [x] NIP07
• [x] NIP19
• [x] NIP44
• [x] NIP94
• [x] NIP96
• [x] NIP98

Roadmap

• [x] Nostraddress service
• [x] Media uploads
• [x] Lightning redirects
• [x] Standalone Installation script
• [x] Docker installation
• [x] Nostr DM integration
• [x] Frontend UI (dashboard)
• [x] Frontend UI (settings)
• [x] Frontend UI (homepage)
• [x] Frontend UI (docs and ToS)
• [ ] Object Storage
• [ ] Multi-server mirroring
• [ ] Lightning payments
• [ ] Import / Export data
• [ ] Custom frontend templates
• [ ] Frontend UI (profile)
• [ ] Frontend UI (public gallery)
• [ ] Frontend UI (public upload)
• [ ] Frontend UI (directory)
• [ ] Frontend UI (register)
• [ ] Umbrel appstore integration
• [ ] Start9 appstore integration
• [ ] Integrated micro-relay

License

MIT License (MIT)

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.