This repository has been archived on 2025-02-09. You can view files and clone it, but cannot push or open issues or pull requests.
kyanite/README.md

32 lines
1.4 KiB
Markdown
Raw Normal View History

2023-02-04 23:26:23 -08:00
# Kyanite
2023-02-03 03:07:04 -08:00
2023-02-04 23:26:23 -08:00
Rusty CMS/Blogging engine thingamabob™
> ⚠️ Kyanite is still **very** early in development and may **not** be ready for your uses just yet! Containers are also on a rolling release.
[![status-badge](https://git.gaycatgirl.sex/evie/kyanite/badges/main/pipeline.svg)](https://git.gaycatgirl.sex/evie/kyanite/-/pipelines)
2023-02-22 00:00:39 -08:00
2023-02-04 23:46:54 -08:00
## Usage
### Container
It's pretty simple as Kyanite only relies on PostgreSQL, no volumes or mounts are needed.
Just use your favourite OCI container software and pull `git.gaycatgirl.sex/evie/kyanite:latest`.
```
podman pull git.gaycatgirl.sex/evie/kyanite:latest
podman run -d --name kyanite -p 3621:3621 -e DATABASE_URL=postgres://xxx:xxx@xxx:xxx/xxx git.gaycatgirl.sex/evie/kyanite:latest
```
### Enviroment Variables
2023-02-04 23:26:23 -08:00
| **ENV VAR** | **DESCRIPTION** | **DEFAULT** |
|:------------:|:-------------------------------------------------------------------:|:-----------:|
| DATABASE_URL | Required. Specifies the connection URl for the PostgreSQL database. | N/A |
| HOST | Optional. The IP that Kyanite will listen on. | 0.0.0.0 |
| PORT | Optional. The port that Kyanite will listen on. | 3621 |
2023-02-05 05:44:02 -08:00
| RUST_LOG | Optional. Sets the logging level. | INFO |
## Features