0 Installation & Setup

M3d4r edited this page 2025-07-06 15:48:52 +02:00

Table of Contents

• 📦 Installation & Setup
• Quick Start (No Install Required)
• Build from Source
• Requirements
• Steps
• Environment Variables

GitHub Repo • Wiki Home • Downloads • Issues

📦 Installation & Setup

Quick Start (No Install Required)

1. Download the latest release from GitHub Releases
2. Extract the archive anywhere
3. Read the included INSTRUCTIONS.txt
4. Run run.sh (Linux/macOS) or run.cmd (Windows)
5. Open http://localhost:3000 in your browser

Build from Source

Requirements

• Node.js
• (Optional) Ollama

Steps

bun i
bun run db:migrate
bun run dev

Visit http://localhost:5173

Environment Variables

PORT=8080 HOST=127.0.0.1 ./run.sh

Available options: HOST, PORT, SOCKET_PATH, ORIGIN, BODY_SIZE_LIMIT, SHUTDOWN_TIMEOUT, IDLE_TIMEOUT

📚 Getting Started

• Home
• Features
• Installation & Setup

🧩 Usage

• Configuration
• Characters & Roleplay
• Connections

🛠️ Development

• Planned Features
• Contributing

📄 Serene Pub on GitHub
🛡️ Licensed under AGPL-3.0 | © 2025 Serene Pub Contributors
🐞 Found a bug? Report it here
💬 Join the discussion in the GitHub Discussions