Add container instructions

This commit is contained in:
Evie Viau-Chow-Stuart 2023-02-04 23:46:54 -08:00
parent 4bed813d20
commit bcc18a83f9
Signed by: evie
GPG key ID: 928652CDFCEC8099
4 changed files with 36 additions and 21 deletions

34
Cargo.lock generated
View file

@ -1160,6 +1160,23 @@ dependencies = [
"log",
]
[[package]]
name = "kyanite"
version = "0.1.0"
dependencies = [
"askama",
"askama_axum",
"axum",
"dotenvy",
"log",
"migration",
"sea-orm 0.11.0-rc.1",
"serde",
"serde_json",
"tokio",
"tracing-subscriber",
]
[[package]]
name = "lazy_static"
version = "1.4.0"
@ -1455,23 +1472,6 @@ version = "2.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "478c572c3d73181ff3c2539045f6eb99e5491218eae919370993b890cdbdd98e"
[[package]]
name = "personal-site"
version = "0.1.0"
dependencies = [
"askama",
"askama_axum",
"axum",
"dotenvy",
"log",
"migration",
"sea-orm 0.11.0-rc.1",
"serde",
"serde_json",
"tokio",
"tracing-subscriber",
]
[[package]]
name = "pest"
version = "2.5.4"

View file

@ -1,9 +1,10 @@
[package]
name = "personal-site"
name = "kyanite"
version = "0.1.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
repository = "https://git.gaycatgirl.sex/evie/kyanite"
license = "Apache-2.0"
[dependencies]

View file

@ -6,6 +6,6 @@ RUN cargo build --release
FROM debian:stable-slim
COPY --from=build ./target/release/personal-site .
COPY --from=build ./target/release/kyanite .
CMD ["./personal-site"]
CMD ["./kyanite"]

View file

@ -4,6 +4,20 @@ 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.
## 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
| **ENV VAR** | **DESCRIPTION** | **DEFAULT** |
|:------------:|:-------------------------------------------------------------------:|:-----------:|
| DATABASE_URL | Required. Specifies the connection URl for the PostgreSQL database. | N/A |