https://github.com/dezh-tech/kraken
A manager service to manage all Jellyfish software stack (Immortal/Panda and ...)
https://github.com/dezh-tech/kraken
dezh grpc http immortal nestjs nip-05 nip05 nostr
Last synced: about 2 months ago
JSON representation
A manager service to manage all Jellyfish software stack (Immortal/Panda and ...)
- Host: GitHub
- URL: https://github.com/dezh-tech/kraken
- Owner: dezh-tech
- Created: 2024-11-04T17:11:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-21T17:34:25.000Z (2 months ago)
- Last Synced: 2025-04-09T21:51:45.472Z (about 2 months ago)
- Topics: dezh, grpc, http, immortal, nestjs, nip-05, nip05, nostr
- Language: TypeScript
- Homepage:
- Size: 1.24 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Kraken
**Kraken** is a management service built with [NestJS](https://nestjs.com/) to handle and configure instances of the **Immortal** Nostr relay. Kraken offers a centralized approach to manage the lifecycle, settings, and configurations of one or more Immortal relay instances, making it an ideal tool for high-demand relays like paid or large community relays.
## Features of Kraken
- **Instance Management**: Easily deploy, start, stop, and monitor Immortal instances.
- **Centralized Configuration**: Manage settings and configurations for multiple instances from a single point.
- **Scalability Support**: Ideal for setups with multiple relays catering to high traffic and community-driven environments.
- **Monitoring**: Integration options for tracking relay performance and usage metrics.
## Installation
1. Clone the repository:
```bash
git clone
cd kraken
```
2. Install dependencies:
```bash
npm install
```
3. Configure the environment variables required by Kraken. Refer to the `.env.example` file for necessary configuration details.
## Usage
To start the Kraken service:
```bash
npm run start
```
The API and management interface will be available at the configured port. Visit the API documentation for details on available endpoints and request formats.
## Contributing
Contributions are welcome! Please submit issues, bug reports, or pull requests to improve Kraken.