diff --git a/README.md b/README.md index 93ff26e8..c65117a8 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Pastebins are a type of online content storage service where users can store pla - [x] Modern, JavaScript-free user interface - [x] Syntax highlighting for all the most popular languages and Raw text mode - [ ] Password-protected encrypted pastes -- [ ] SQLite Support +- [x] SQLite Support - [ ] Paste collections - [ ] Reader view mode (Markdown is formatted and word wrapping is enabled) - [ ] QR Codes @@ -42,6 +42,7 @@ Pastebins are a type of online content storage service where users can store pla - [Using Docker](#using-docker) - [Manually](#manually) - [Environment Variables](#environment-variables) + - [Database Connection URI](#database-connection-uri) - [Usage](#usage) - [On the Web](#on-the-web) - [CLI](#cli) @@ -64,7 +65,8 @@ $ sudo docker run -d -p 80:9000 spacebinorg/spirit #### Manually -> [!IMPORTANT] > **Requires: [Git](https://git-scm.com/downloads), [Go 1.22.4](https://go.dev/doc/install), [GNU Makefile](https://www.gnu.org/software/make/#download), and a [PostgreSQL](https://www.postgresql.org/download/) [server](https://m.do.co/c/beaf675c3e00).** +> [!IMPORTANT] +> **Requires: [Git](https://git-scm.com/downloads), [Go 1.22.4](https://go.dev/doc/install), [GNU Makefile](https://www.gnu.org/software/make/#download), and a SQLite database or [PostgreSQL](https://www.postgresql.org/download/) [server](https://m.do.co/c/beaf675c3e00).** ```sh # Clone the Github repository @@ -75,37 +77,46 @@ $ cd spacebin $ make spirit # Start Spacebin -$ SPIRIT_CONNECTION_URI="" ./bin/spirit +$ SPIRIT_CONNECTION_URI="sqlite://database.sqlite" ./bin/spirit # SQLite +$ SPIRIT_CONNECTION_URI="postgres://" ./bin/spirit # PostgreSQL # Success! Spacebin is now available at port 9000 on your machine. ``` #### Environment Variables -| Variable Name | Type | Default | Description | -| ----------------------- | --------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `SPIRIT_HOST` | String | `0.0.0.0` | Host address to listen on | -| `SPIRIT_PORT` | Int | `9000` | HTTP port to listen on | -| `SPIRIT_RATELIMITER` | String | `200x5` | Requests allowed per second before the user is ratelimited | -| `SPIRIT_CONNECTION_URI` | String | **Required** | [PostgreSQL Database URI String](https://stackoverflow.com/questions/3582552/what-is-the-format-for-the-postgresql-connection-string-url#20722229) | -| `SPIRIT_HEADLESS` | Bool | `False` | Enables/disables the web interface | -| `SPIRIT_ANALYTICS` | String | `""` | `