prepare release

sebadob · Jul 10, 2023 · c57cc93 · c57cc93
1 parent 85fbafe
commit c57cc93
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.13.2
+
+- General code and project cleanup
+[4531ae9](https://github.com/sebadob/rauthy/commit/4531ae93d453429a54198211b7d122dada452ae4)
+[782bb9a](https://github.com/sebadob/rauthy/commit/782bb9adbbb12f77232b1820e7dd05265c0fdf00)
+[0c5ad02](https://github.com/sebadob/rauthy/commit/0c5ad02e369935b01aac46988a2242c859737e24)
+[e453142](https://github.com/sebadob/rauthy/commit/e45314269234612a3eec046073e988e260a7ca31)
+[85fbafe](https://github.com/sebadob/rauthy/commit/85fbafe5ef6b8f124af6af1508b6e2bab067a8ff)
+- Created a `justfile` for easier development handling
+[4aa5b99](https://github.com/sebadob/rauthy/commit/4aa5b9993897e43dfc765eb2849172bc087ea34c)
+[1489efe](https://github.com/sebadob/rauthy/commit/1489efe139c0a0c79169f47ba4fc964cdc6b6e3e)
+- UI: fixed some visual bugs and improved the rendering with larger default browser fonts
+[45334fd](https://github.com/sebadob/rauthy/commit/45334fd65049f2950dae3a2bc28c5667c275aa1d)
+
 ## v0.13.1
 
 This is just a small bugfix release.

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM alpine3.18 AS builderBackend
+FROM alpine:3.18.2 AS builderBackend
 
 WORKDIR /work
 

diff --git a/build_local.sh b/build_local.sh
@@ -11,12 +11,12 @@ docker push registry.netitservices.com/sd/rauthy:$TAG
 docker build --no-cache -f Dockerfile.debug -t registry.netitservices.com/sd/rauthy:$TAG-debug .
 docker push registry.netitservices.com/sd/rauthy:$TAG-debug
 
-# tagged public release
-docker tag registry.netitservices.com/sd/rauthy:$TAG sdobedev/rauthy:$TAG
-docker push sdobedev/rauthy:$TAG
-docker tag registry.netitservices.com/sd/rauthy:$TAG-debug sdobedev/rauthy:$TAG-debug
-docker push sdobedev/rauthy:$TAG-debug
-
-# latest public release
-docker tag registry.netitservices.com/sd/rauthy:$TAG sdobedev/rauthy:latest
-docker push sdobedev/rauthy:latest
+## tagged public release
+#docker tag registry.netitservices.com/sd/rauthy:$TAG sdobedev/rauthy:$TAG
+#docker push sdobedev/rauthy:$TAG
+#docker tag registry.netitservices.com/sd/rauthy:$TAG-debug sdobedev/rauthy:$TAG-debug
+#docker push sdobedev/rauthy:$TAG-debug
+#
+## latest public release
+#docker tag registry.netitservices.com/sd/rauthy:$TAG sdobedev/rauthy:latest
+#docker push sdobedev/rauthy:latest
diff --git a/dev_notes.md b/dev_notes.md
@@ -40,6 +40,7 @@ in another terminal:
 - check why DB migration returned an error inside OCI Pods only (and nowhere else)
 - possible improvement: test if it makes a difference and maybe initialize argon2 hasher only once
 - benchmarks and performance tuning
+- double check against https://openid.net/specs/openid-connect-core-1_0.html that everything is implemented correctly one more time
 
 ### Stage 3 - Possible nice to haves
 
@@ -48,11 +49,9 @@ in another terminal:
 - auto-encrypted backups + backups to remote locations (ssh, nfs, s3, ...) -> postponed - should be applied to sqlite only
 since postgres has pg_backrest and a lot of well established tooling anyway
 - when a user changes his email address, set email to not verified again and send a validation email
-- double check against https://openid.net/specs/openid-connect-core-1_0.html that everything is implemented correctly one more time
 - add all default claims for users https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims
 - oidc-client (google, github, ...)
 - 'rauthy-migrate' project to help migrating to rauthy?
-- add mysql?
 - add tracing-actix-web + opentelemetry
 - observe the svelte issue about the necessary 'unsafe-inline' CSP --> update: should be fixed with svelte 4
 - NATS events stream or maybe internal one?

diff --git a/docs/index.html b/docs/index.html
@@ -191,6 +191,12 @@ <h2 id="what-it-is"><a class="header" href="#what-it-is">What it is</a></h2>
 away or just a bit slower, because it is maybe running on an SBC from an SD card. Most things are even cached 
 for several hours (config options will come in the future) and special care has been taken into account in case of cache
 eviction and invalidation.<br />
+A Rauthy deployment with the embedded SQLite, filled caches and a small set of clients and users configured typically
+only uses <strong>between 15 and 20 MB of memory</strong>! This is pretty awesome when comparing it to other existing solutions
+out there. If a password from a login is hashed, the memory consumption will of course go up way higher than this
+depending on your configured Argon2ID parameters, which you got fully under control. If you use it with an external
+Postgres, the memory consumption of Rauthy itself will even be a bit lower, since it does not need to care about SQLite.
+<br />
 For achieving this speed and efficiency, some additional design tradeoffs werde made. For instance, some things you
 configure statically via config file and not dynamically via UI, while most of them are configured once and then never
 touched again.</p>
@@ -222,9 +228,7 @@ <h2 id="what-it-is-not-yet"><a class="header" href="#what-it-is-not-yet">What it
 <p><strong>Rauthy Authenticator MFA App</strong><br />
 Even though things like OTP codes will never be implemented, it is not set in stone yet that there will never be Rauthy's
 own Authenticator App, which then basically acts as a Webauthn Software Authenticator. There are already existing 
-solutions out there to serve this purpose.<br />
-In the current version, deprecated artifacts of a first approach for its own Authenticator App do exist, but they will
-be cleaned up in the near future.</p>
+solutions out there to serve this purpose.</p>
 <p><strong>Customizable E-Mail templates</strong><br />
 It is unsure, if this feature will come.</p>
 <p><strong>OIDC Client</strong><br />

diff --git a/docs/intro.html b/docs/intro.html
@@ -191,6 +191,12 @@ <h2 id="what-it-is"><a class="header" href="#what-it-is">What it is</a></h2>
 away or just a bit slower, because it is maybe running on an SBC from an SD card. Most things are even cached 
 for several hours (config options will come in the future) and special care has been taken into account in case of cache
 eviction and invalidation.<br />
+A Rauthy deployment with the embedded SQLite, filled caches and a small set of clients and users configured typically
+only uses <strong>between 15 and 20 MB of memory</strong>! This is pretty awesome when comparing it to other existing solutions
+out there. If a password from a login is hashed, the memory consumption will of course go up way higher than this
+depending on your configured Argon2ID parameters, which you got fully under control. If you use it with an external
+Postgres, the memory consumption of Rauthy itself will even be a bit lower, since it does not need to care about SQLite.
+<br />
 For achieving this speed and efficiency, some additional design tradeoffs werde made. For instance, some things you
 configure statically via config file and not dynamically via UI, while most of them are configured once and then never
 touched again.</p>
@@ -222,9 +228,7 @@ <h2 id="what-it-is-not-yet"><a class="header" href="#what-it-is-not-yet">What it
 <p><strong>Rauthy Authenticator MFA App</strong><br />
 Even though things like OTP codes will never be implemented, it is not set in stone yet that there will never be Rauthy's
 own Authenticator App, which then basically acts as a Webauthn Software Authenticator. There are already existing 
-solutions out there to serve this purpose.<br />
-In the current version, deprecated artifacts of a first approach for its own Authenticator App do exist, but they will
-be cleaned up in the near future.</p>
+solutions out there to serve this purpose.</p>
 <p><strong>Customizable E-Mail templates</strong><br />
 It is unsure, if this feature will come.</p>
 <p><strong>OIDC Client</strong><br />

diff --git a/docs/print.html b/docs/print.html
@@ -192,6 +192,12 @@ <h2 id="what-it-is"><a class="header" href="#what-it-is">What it is</a></h2>
 away or just a bit slower, because it is maybe running on an SBC from an SD card. Most things are even cached 
 for several hours (config options will come in the future) and special care has been taken into account in case of cache
 eviction and invalidation.<br />
+A Rauthy deployment with the embedded SQLite, filled caches and a small set of clients and users configured typically
+only uses <strong>between 15 and 20 MB of memory</strong>! This is pretty awesome when comparing it to other existing solutions
+out there. If a password from a login is hashed, the memory consumption will of course go up way higher than this
+depending on your configured Argon2ID parameters, which you got fully under control. If you use it with an external
+Postgres, the memory consumption of Rauthy itself will even be a bit lower, since it does not need to care about SQLite.
+<br />
 For achieving this speed and efficiency, some additional design tradeoffs werde made. For instance, some things you
 configure statically via config file and not dynamically via UI, while most of them are configured once and then never
 touched again.</p>
@@ -223,9 +229,7 @@ <h2 id="what-it-is-not-yet"><a class="header" href="#what-it-is-not-yet">What it
 <p><strong>Rauthy Authenticator MFA App</strong><br />
 Even though things like OTP codes will never be implemented, it is not set in stone yet that there will never be Rauthy's
 own Authenticator App, which then basically acts as a Webauthn Software Authenticator. There are already existing 
-solutions out there to serve this purpose.<br />
-In the current version, deprecated artifacts of a first approach for its own Authenticator App do exist, but they will
-be cleaned up in the near future.</p>
+solutions out there to serve this purpose.</p>
 <p><strong>Customizable E-Mail templates</strong><br />
 It is unsure, if this feature will come.</p>
 <p><strong>OIDC Client</strong><br />

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/out/rauthy b/out/rauthy
diff --git a/rauthy-book/src/intro.md b/rauthy-book/src/intro.md
@@ -38,7 +38,13 @@ and being more efficient with resources. For instance, Rauthy can easily run a f
 Raspberry Pi. It makes extensive use of caching to be as fast as possible in cases where your database is further
 away or just a bit slower, because it is maybe running on an SBC from an SD card. Most things are even cached 
 for several hours (config options will come in the future) and special care has been taken into account in case of cache
-eviction and invalidation.  
+eviction and invalidation.<br />
+A Rauthy deployment with the embedded SQLite, filled caches and a small set of clients and users configured typically
+only uses **between 15 and 20 MB of memory**! This is pretty awesome when comparing it to other existing solutions
+out there. If a password from a login is hashed, the memory consumption will of course go up way higher than this
+depending on your configured Argon2ID parameters, which you got fully under control. If you use it with an external
+Postgres, the memory consumption of Rauthy itself will even be a bit lower, since it does not need to care about SQLite.
+<br />
 For achieving this speed and efficiency, some additional design tradeoffs werde made. For instance, some things you
 configure statically via config file and not dynamically via UI, while most of them are configured once and then never
 touched again.
@@ -80,8 +86,6 @@ other deployment name.
 Even though things like OTP codes will never be implemented, it is not set in stone yet that there will never be Rauthy's
 own Authenticator App, which then basically acts as a Webauthn Software Authenticator. There are already existing 
 solutions out there to serve this purpose.  
-In the current version, deprecated artifacts of a first approach for its own Authenticator App do exist, but they will
-be cleaned up in the near future.
 
 **Customizable E-Mail templates**  
 It is unsure, if this feature will come.