Merge pull request #54 from hjr3/docs

feat: add documentation

.gitignore

@@ -1,3 +1,4 @@
 target
 soldr.db
 crates/ui/static
+index.html

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/README.md

@@ -0,0 +1,16 @@
+# Docs
+
+## Requirements
+
+- mdbook - https://rust-lang.github.io/mdBook/index.html
+- mdbook-mermaid - https://github.com/badboy/mdbook-mermaid
+
+## Modifying Docs
+
+Build the docs and start a local webserver:
+
+```
+mdbook serve
+```
+
+You can leave the server running even while you edit the content of the docs. The docs will be automatically rebuilt the output and automatically refresh your web browser.

docs/book.toml

@@ -0,0 +1,24 @@
+[book]
+authors = ["Herman J. Radtke III"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Soldr"
+
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
+[output.html]
+git-repository-url = "https://github.com/hjr3/soldr/tree/main/docs"
+edit-url-template = "https://github.com/hjr3/soldr/edit/main/docs/{path}"
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
+
+[output.html.search]
+limit-results = 20
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 2
+boost-paragraph = 1
+expand = true
+heading-split-level = 2

docs/mermaid-init.js

@@ -0,0 +1 @@
+mermaid.initialize({startOnLoad:true});

docs/src/SUMMARY.md

@@ -0,0 +1,6 @@
+[Introduction](../../README.md)
+
+# Getting Started
+
+- [Installation](installation.md)
+- [Configuration](configuration.md)

docs/src/configuration.md

@@ -0,0 +1,19 @@
+# Configuration
+
+Soldr is designed to start running without requiring a configuration file.
+
+You can configure soldr by creating a configuration file in the [TOML](https://toml.io) format. 
+
+Example:
+
+```toml
+database_url = "sqlite:soldr.db?mode=rwc"
+management_listener = "0.0.0.0:3443"
+ingest_listener = "0.0.0.0:3000"
+```
+
+The repository also includes `soldr.example.toml` for reference.
+
+- `database_url` - the SQLite database connection string
+- `management_listener` - the ip address and port for the management API
+- `ingest_listener` - the ip address and port for the proxy

docs/src/installation.md

@@ -0,0 +1,13 @@
+# Installation
+
+Soldr is not currently pre-packaged.
+
+To install:
+
+- `git clone https://github.com/hjr3/soldr.git`
+- `cd soldr`
+- `just install build-ui`
+   - If you do not have `just` installed, you can manually run the commands from the file.
+- `cargo build --release` will create two targets:
+   - `target/release/soldr` - this is the proxy and the management API
+   - `target/release/ui` - this a file server that serves the management UI. The management UI is optional.