fix: rename project to minauthator

README.md

@@ -1,14 +1,31 @@
 # Minauthator
 
-Auth provider supporting [OAuth2](https://datatracker.ietf.org/doc/html/rfc6749).
+Minauthator is an identity provider supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect).
+
+This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software.
+
+**Project status: *early development, work-in-progress***
 
 ## Features
 
-- [x] register
-- [x] login
-- [ ] authorize
+- Login
+- Register
+- OpenID Connect & OAuth 2.0
+- Activation token
+- Profile details
+- Static apps
+- User roles
+- MFA/TOTP
+- Email notifications
+- Login page customization
+- App carousel (App presentation to users)
 
 ## Deps
 
 - <https://github.com/murar8/axum_typed_multipart>
 
+## Alternatives
+
+- [Authentik](https://goauthentik.io/)
+- [Keycloak](https://www.keycloak.org/)
+

justfile

@@ -2,20 +2,20 @@ export RUST_BACKTRACE := "1"
 export RUST_LOG := "trace"
 
 watch-run:
-    cargo-watch -x 'run -- --config ./config.toml --database ./tmp/dbs/minauth.db --static-assets ./assets'
+    cargo-watch -x 'run -- --config ./config.toml --database ./tmp/dbs/minauthator.db --static-assets ./assets'
 
 run:
-    cargo run -- --database ./tmp/dbs/minauth.db --config ./config.toml --static-assets ./assets
+    cargo run -- --database ./tmp/dbs/minauthator.db --config ./config.toml --static-assets ./assets
 
 docker-run:
-    docker run -p 3085:8080 -v ./tmp/docker/config:/etc/minauth -v ./tmp/docker/db:/var/lib/minauth minauth
+    docker run -p 3085:8080 -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator
 
 docker-init-db:
-    docker run -v ./tmp/docker/config:/etc/minauth -v ./tmp/docker/db:/var/lib/minauth autotasker /usr/local/bin/minauth_init_db.sh
+    docker run -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator /usr/local/bin/minauthator_init_db.sh
 
 docker-build:
-    docker build -t minauth .
+    docker build -t minauthator .
 
 init-db:
-    sqlite3 -echo tmp/dbs/minauth.db < migrations/all.sql
+    sqlite3 -echo tmp/dbs/minauthator.db < migrations/all.sql
 

src/cli.rs

@@ -5,9 +5,9 @@ use log::info;
 use crate::{get_app_context, server::{start_http_server, ServerConfig}, DEFAULT_ASSETS_PATH};
 
 #[derive(Debug, FromArgs)]
-/// Autotasker daemon
+/// Minauthator daemon
 struct ServerCliFlags {
-    /// path to YAML config file to use to configure autotasker
+    /// path to YAML config file to use to configure this instance
     #[argh(option)]
     config: Option<String>,
 

src/main.rs

@@ -17,9 +17,9 @@ use log::info;
 use sqlx::{Pool, Sqlite};
 use models::config::{AppSecrets, Config};
 
-pub const DEFAULT_DB_PATH: &str = "/var/lib/autotasker/autotasker.db";
-pub const DEFAULT_ASSETS_PATH: &str = "/usr/local/lib/autotasker/assets";
-pub const DEFAULT_CONFIG_PATH: &str = "/etc/autotasker/config.yaml";
+pub const DEFAULT_DB_PATH: &str = "/var/lib/minauthator/minauthator.db";
+pub const DEFAULT_ASSETS_PATH: &str = "/usr/local/lib/minauthator/assets";
+pub const DEFAULT_CONFIG_PATH: &str = "/etc/minauthator/config.yaml";
 
 fn get_config(path: String) -> Result<Config> {
     let inp_def_yaml = fs::read_to_string(path)

src/models/config.rs

@@ -37,9 +37,8 @@ struct Role {
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[fully_pub]
-/// Configuration of this minauthator instance
+/// Configuration of this Minauthator instance
 struct Config {
-    /// configure current autotasker instance
     instance: InstanceConfig,
     applications: Vec<Application>,
     roles: Vec<Role>

src/models/token_claims.rs

@@ -21,7 +21,7 @@ impl UserTokenClaims {
         UserTokenClaims {
             sub: user_id.into(),
             exp: get_current_timestamp() + 86_000,
-            iss: "Minauth".into()
+            iss: "Minauthator".into()
         }
     }
 }

src/templates/pages/home.html

@@ -1,9 +1,9 @@
 {% extends "layouts/base.html" %}
 {% block body %}
-<h1>Bienvenue sur Minauth</h1>
+<h1>Bienvenue sur Minauthator</h1>
 
 <p>
-Minauth is free software under <a href="https://www.gnu.org/licenses/gpl-3.0.txt">GPLv3</a> licence.
+Minauthator is free software under <a href="https://www.gnu.org/licenses/gpl-3.0.txt">GPLv3</a> licence.
 
 You can find source code on a <a href="https://forge.lefuturiste.fr/mbess/minauth">self-hosted forge repository</a>.
 </p>