Compare commits

..

5 Commits

Author SHA1 Message Date
98f77b40c6 tsk-56: Version bump
All checks were successful
Rust Build / Check (pull_request) Successful in 39s
Rust Build / Test Suite (pull_request) Successful in 1m23s
Rust Build / Rustfmt (pull_request) Successful in 31s
Rust Build / build (pull_request) Successful in 1m6s
Rust Build / Clippy (pull_request) Successful in 1m34s
2025-08-24 19:48:13 -04:00
03a63833e0 tsk-56: icarus_models version bump 2025-08-24 19:47:12 -04:00
be053ac0dc tsk-56: Added API docs
All checks were successful
Rust Build / Check (pull_request) Successful in 2m3s
Rust Build / Test Suite (pull_request) Successful in 2m54s
Rust Build / Rustfmt (pull_request) Successful in 29s
Rust Build / Clippy (pull_request) Successful in 2m2s
Rust Build / build (pull_request) Successful in 3m36s
2025-08-24 19:02:20 -04:00
d4ec3c5d1c tsk-56: Added utoipa Swagger crates 2025-08-24 15:50:40 -04:00
50f517140e tsk-56: Dependency version brump
icarus_models and icarus_envy version bump
2025-08-24 15:48:39 -04:00
3 changed files with 5 additions and 11 deletions

2
Cargo.lock generated
View File

@@ -749,7 +749,7 @@ dependencies = [
[[package]] [[package]]
name = "icarus_auth" name = "icarus_auth"
version = "0.5.0" version = "0.4.4"
dependencies = [ dependencies = [
"argon2", "argon2",
"axum", "axum",

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "icarus_auth" name = "icarus_auth"
version = "0.5.0" version = "0.4.4"
edition = "2024" edition = "2024"
rust-version = "1.88" rust-version = "1.88"

View File

@@ -1,12 +1,9 @@
A auth web API services for the Icarus project.
# Getting Started # Getting Started
The easiest way to get started is through docker. This assumes that docker is already installed Copy the `.env.sample` file to `.env` and ensure that the variables are populated. This project
on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't can be used with regular hosting or with docker. For the sake of getting up to speed quickly,
need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token Docker will be covered. Make sure docker is running and your ssh identity has been loaded.
generation. The `SECRET_PASSPHASE` should also be changed when in production mode, but make sure
the respective `passphrase` database table record exists.
Build image Build image
``` ```
@@ -27,6 +24,3 @@ Pruning
``` ```
docker system prune -a docker system prune -a
``` ```
To view the OpenAPI spec, run the project and access `/swagger-ui`. If running through docker,
the url would be something like `http://localhost:8000/swagger-ui`.