mirror of
https://github.com/Routstr/routstr-core.git
synced 2026-10-05 20:28:23 +00:00
Updated deployment docs
This commit is contained in:
@@ -51,14 +51,26 @@ curl https://api.routstr.com/v1/chat/completions \
|
|||||||
|
|
||||||
## Quick Start (Docker)
|
## Quick Start (Docker)
|
||||||
|
|
||||||
If you are a node runner, start a Routstr Core instance and configure upstream access in the dashboard.
|
If you are a node runner, start a Routstr Core instance using Docker Compose:
|
||||||
|
|
||||||
```bash
|
1. **Prepare your `.env`**:
|
||||||
docker run -d \
|
```bash
|
||||||
--name routstr-proxy \
|
ADMIN_PASSWORD=mysecretpassword
|
||||||
-p 8000:8000 \
|
NAME="My AI Node"
|
||||||
ghcr.io/routstr/proxy:latest
|
DESCRIPTION="Fast access to models"
|
||||||
```
|
NSEC=yournsec
|
||||||
|
RECEIVE_LN_ADDRESS=yourname@wallet.com
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Start the services**:
|
||||||
|
```bash
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Configure**:
|
||||||
|
Open [http://localhost:8000/admin/](http://localhost:8000/admin/) to connect your AI providers and set pricing.
|
||||||
|
|
||||||
|
For full instructions, see the **[Provider Quick Start Guide](https://docs.routstr.com/provider/quickstart/)**.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|||||||
@@ -6,16 +6,7 @@ Production deployment guide for Routstr Provider nodes.
|
|||||||
|
|
||||||
For production, use Docker Compose with persistent storage and optional Tor support.
|
For production, use Docker Compose with persistent storage and optional Tor support.
|
||||||
|
|
||||||
### Unified Setup (All-in-one)
|
Use the included `compose.yml` for a flexible setup that handles both the UI and the node execution. This is useful for development or when you want to manage Tor as a separate service.
|
||||||
To build and run the node with the UI integrated in a single container using the multi-stage build:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker build -f Dockerfile.full -t routstr-full .
|
|
||||||
docker run -d -p 8000:8000 --env-file .env routstr-full
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Setup (Separated UI & Node)
|
|
||||||
Use the included `compose.yml` for a more flexible setup that separates the UI build process from the node execution. This is useful for development or when you want to manage Tor as a separate service.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
@@ -184,20 +175,16 @@ docker compose up -d
|
|||||||
|
|
||||||
## Building from Source
|
## Building from Source
|
||||||
|
|
||||||
### Unified Image (UI + Node)
|
### Using Docker Compose
|
||||||
The easiest way to build everything from source into a single production-ready image:
|
The easiest way to build everything from source:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -f Dockerfile.full -t routstr-full .
|
docker compose build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Individual Components
|
### Individual Components
|
||||||
If you prefer building them separately or using Docker Compose:
|
If you prefer building the node only (requires manual UI build first):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build using compose
|
|
||||||
docker compose build
|
|
||||||
|
|
||||||
# Or build the node only (requires manual UI build first)
|
|
||||||
docker build -t routstr-node .
|
docker build -t routstr-node .
|
||||||
```
|
```
|
||||||
|
|||||||
+12
-24
@@ -35,6 +35,7 @@ ADMIN_PASSWORD=mysecretpassword
|
|||||||
# Node Identity
|
# Node Identity
|
||||||
NAME="My AI Node"
|
NAME="My AI Node"
|
||||||
DESCRIPTION="Fast access to models"
|
DESCRIPTION="Fast access to models"
|
||||||
|
NSEC=yournsec
|
||||||
|
|
||||||
# Lightning Payouts
|
# Lightning Payouts
|
||||||
RECEIVE_LN_ADDRESS=yourname@wallet.com
|
RECEIVE_LN_ADDRESS=yourname@wallet.com
|
||||||
@@ -43,32 +44,10 @@ RECEIVE_LN_ADDRESS=yourname@wallet.com
|
|||||||
|
|
||||||
## 2. Start the Node
|
## 2. Start the Node
|
||||||
|
|
||||||
You can run the pre-built image directly:
|
The recommended way to run Routstr is using Docker Compose, which handles the node, the UI, and optional services like Tor.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d \
|
docker compose up -d
|
||||||
--name routstr \
|
|
||||||
-p 8000:8000 \
|
|
||||||
--env-file .env \
|
|
||||||
-v routstr-data:/app/data \
|
|
||||||
ghcr.io/routstr/proxy:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
*Note: The pre-built image does not contain the UI. For the all-in-one experience with the Admin Dashboard, use the Build from Source instructions below.*
|
|
||||||
|
|
||||||
### Build from Source (Recommended)
|
|
||||||
|
|
||||||
If you want to build the node and UI yourself from source, use the unified Dockerfile:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/routstr/routstr-core.git
|
|
||||||
cd routstr-core
|
|
||||||
# Edit your .env with ADMIN_PASSWORD and API keys
|
|
||||||
cp .env.example .env
|
|
||||||
nano .env
|
|
||||||
|
|
||||||
docker build -f Dockerfile.full -t routstr-local .
|
|
||||||
docker run -d -p 8000:8000 --env-file .env --name routstr routstr-local
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Verify it's running:
|
Verify it's running:
|
||||||
@@ -77,6 +56,15 @@ Verify it's running:
|
|||||||
curl http://localhost:8000/v1/info
|
curl http://localhost:8000/v1/info
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Build from Source (Optional)
|
||||||
|
|
||||||
|
If you've cloned the repository and want to build the images yourself:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose build
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3. Configure via Dashboard
|
## 3. Configure via Dashboard
|
||||||
|
|||||||
Reference in New Issue
Block a user