chore: simplify docs structure

This commit is contained in:
sjdonado
2025-11-02 11:31:17 +01:00
parent 353cf68852
commit 9fcd478f86
3 changed files with 95 additions and 85 deletions
-61
View File
@@ -9,67 +9,6 @@ Options:
--update-parsers Download all required data files
```
## Run It Anywhere
### Docker Compose
```bash
docker-compose up
# Optional: Generate an api key
# docker-compose exec -it app cli --create-user=Admin
```
### Docker CLI
```bash
docker run \
--name bit \
-p 4000:4000 \
-e ENV="production" \
-e DATABASE_URL="sqlite3://./sqlite/data.db" \
-e APP_URL="http://localhost:4000" \
-e ADMIN_NAME="Admin" \
-e ADMIN_API_KEY=$(openssl rand -base64 32) \
sjdonado/bit
# Create a new user
# docker exec -it bit cli --create-user=Admin
```
### Dokku
```dockerfile
FROM sjdonado/bit
```
```bash
dokku apps:create bit
dokku domains:set bit bit.donado.co
dokku letsencrypt:enable bit
dokku storage:ensure-directory bit-sqlite
dokku storage:mount bit /var/lib/dokku/data/storage/bit-sqlite:/usr/src/app/sqlite/
dokku config:set bit DATABASE_URL="sqlite3://./sqlite/data.db" APP_URL=https://bit.donado.co ADMIN_NAME=Admin ADMIN_API_KEY=$(openssl rand -base64 32)
dokku ports:add bit http:80:4000
dokku ports:add bit https:443:4000
# Create a new user
# dokku run bit cli --create-user=Admin
```
### Dokku (same network)
Recommended for lower latency communication (no host network traversal)
```bash
dokku network:create bit-net
dokku network:set bit attach-post-create bit-net
dokku network:set myapp attach-post-create bit-net
```
## Local Development
### Requirements
+16 -7
View File
@@ -1,7 +1,16 @@
openapi: 3.1.0
openapi: 3.0.3
info:
title: Bit - URL Shortener API
description: A high-performance URL shortener service with click tracking and analytics
description: |
Fast, lightweight, self-hosted URL shortener service with minimal click tracking.
## Getting Started
For setup instructions, please check the [README](https://github.com/sjdonado/bit/blob/master/README.md).
## Authentication
Multiple users are supported via `X-Api-Key` headers. Create, list and delete keys via the [CLI](https://github.com/sjdonado/bit/blob/master/SETUP.md#cli).
version: 1.0.0
contact:
name: API Support
@@ -423,24 +432,24 @@ components:
example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:127.0) Gecko/20100101 Firefox/127.0
country:
type: string
nullable: true
description: Country code (ISO 3166-1 alpha-2)
example: US
nullable: true
browser:
type: string
nullable: true
description: Browser name
example: Firefox
nullable: true
os:
type: string
nullable: true
description: Operating system
example: Mac OS X
nullable: true
referer:
type: string
nullable: true
description: Referer domain or utm_source
example: Direct
nullable: true
created_at:
type: string
format: date-time
@@ -457,9 +466,9 @@ components:
next:
type: integer
format: int64
nullable: true
description: Cursor for next page (link/click ID)
example: 12
nullable: true
Error:
type: object