letro/letro-authentication-service
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Quentin Gliech
2022-02-07 16:10:44 +01:00
parent 81a9a00ec7
commit 213f5fe1b2
7 changed files with 60 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/development/architecture.md
View File

@@ -9,10 +9,19 @@ The whole repository is a [Cargo Workspace](https://doc.rust-lang.org/book/ch14-
This includes:
- `oauth2-types`: Useful structures and types to deal with OAuth 2.0/OpenID Connect endpoints. This might end up published as a standalone library as it can be useful in other contexts.
- `mas-config`: Configuration parsing and loading
- `mas-core`: Main logic, includes templates, database interactions and HTTP routes
- `mas-cli`: Command line utility, main entry point
- `mas-config`: Configuration parsing and loading
- `mas-data-model`: Models of objects that live in the database, regardless of the storage backend
- `mas-email`: High-level email sending abstraction
- `mas-handlers`: Main HTTP application logic
- `mas-iana`: Auto-generated enums from IANA registries
- `mas-iana-codegen`: Code generator for the `mas-iana` crate
- `mas-jose`: JWT/JWS/JWE/JWK abstraction
- `mas-static-files`: Frontend static files (CSS/JS). Includes some frontend tooling
- `mas-storage`: Interactions with the database
- `mas-tasks`: Asynchronous task runner and scheduler
- `mas-warp-utils`: Various filters and utilities for the `warp` web framework
- `oauth2-types`: Useful structures and types to deal with OAuth 2.0/OpenID Connect endpoints. This might end up published as a standalone library as it can be useful in other contexts.
## Important crates

4
docs/development/database.md
View File

@@ -14,7 +14,7 @@ Preparing this flat file is done through `sqlx-cli`, and should be done everytim
# Install the CLI
cargo install sqlx-cli --no-default-features --features postgres
cd crates/core/ # Must be in the mas-core crate folder
cd crates/storage/ # Must be in the mas-storage crate folder
export DATABASE_URL=postgresql:///matrix_auth
cargo sqlx prepare
```
@@ -24,7 +24,7 @@ cargo sqlx prepare
Migration files live in the `migrations` folder in the `mas-core` crate.
```sh
cd crates/core/ # Again, in the mas-core crate folder
cd crates/storage/ # Again, in the mas-storage crate folder
export DATABASE_URL=postgresql:///matrix_auth
cargo sqlx migrate run # Run pending migrations
cargo sqlx migrate revert # Revert the last migration

2
docs/development/warp.md
View File

@@ -1,5 +1,7 @@
# `warp`
**Warning: this document is not up to date**
Warp has a pretty unique approach in terms of routing.
It does not have a central router, rather a chain of filters composed together.