Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Configuration Guide

## Environment Variables

| Variable | Description | Default |
|---|---|---|
| `PORT` | Port the server runs on | `8000` |
| `DEBUG` | Enable debug mode | `false` |
| `SECRET_KEY` | Application secret key | (required) |
| `DATABASE_URL` | Database connection string | (required) |

## Setting up .env
Create a `.env` file in the root directory and fill in the values above.
27 changes: 27 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Installation Guide

## Prerequisites
- Git installed on your machine
- A server or local machine to self-host

## Steps

### 1. Clone the repository
```bash
git clone https://github.com/bos-com/BOS.git
cd BOS
```

### 2. Configure environment
Copy the example environment file and edit it:
```bash
cp .env.example .env
```

### 3. Run the application
```bash
# Instructions will be added as the project develops
```

## Troubleshooting
Open an issue at https://github.com/bos-com/BOS/issues if you encounter problems.
13 changes: 13 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Usage Guide

## Starting BOS
Once installed, BOS can be accessed via your browser at `http://localhost:8000`

## Self-hosting
BOS is designed to be self-hostable. You can deploy it on:
- A personal VPS (e.g. DigitalOcean, Linode)
- A local server on your network
- A cloud provider (AWS, GCP, Azure)

## Configuration
See [configuration.md](./configuration.md) for all available options.