Merge pull request #124 from sebadob/prepare-release-v0.17.0

Prepare release v0.17.0

CHANGELOG.md

@@ -6,6 +6,13 @@ This is a pretty huge update with a lot of new features.
 
 ### New Features
 
+#### Support for `linux/arm64`
+
+With the release of v0.17.0, Rauthy's container images are now multi-platform.
+
+Both a `linux/amd64` and a `linux/arm64` are supported. This means you can "just use it" now on Raspberry Pi and
+others, or on Ampere architecture from Cloud providers without the need to compile it yourself.
+
 #### Events and Auditing
 
 Rauthy now produces events in all different kinds of situations. These can be used for auditing, monitoring, and so on.
@@ -187,6 +194,8 @@ if there is a stable update available.
 
 ### Changes
 
+- Support for `linux/arm64`
+[2abb071](https://github.com/sebadob/rauthy/commit/2abb071afd6e9379fa3deca233c649bf62d33032)
 - New events and auditing
 [758dda6](https://github.com/sebadob/rauthy/commit/758dda631734c0c8e5baddf79ff2b0aa67947929)
 [488f9de](https://github.com/sebadob/rauthy/commit/488f9de03653c5eb2c673644deb188599763afbb)
@@ -197,7 +206,7 @@ if there is a stable update available.
 [a9af494](https://github.com/sebadob/rauthy/commit/a9af494bba788e462bb22eb31131d19b5ffaeaed)
 [797dad5](https://github.com/sebadob/rauthy/commit/797dad564ff190b8739393c0405486b8f55b057e)
 [b338f26](https://github.com/sebadob/rauthy/commit/b338f2613e9d19581677915c5ceb1996653709d7)
-- `rauthy-notify` crate has been added which implements the above mentioned Slack and
+- `rauthy-notify` crate has been added which implements the above-mentioned Slack and
 Matrix integrations for Event notifications.
 [8767389](https://github.com/sebadob/rauthy/commit/8767389dafe3dc392910135d8cfc7f6a63bf3cd5)
 - Increasing login timeouts and delays after invalid logins

Cargo.toml

@@ -10,7 +10,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.17.0-beta2"
+version = "0.17.0"
 edition = "2021"
 authors = ["Sebastian Dobe <[email protected]>"]
 license = "AGPLv3"

README.md

@@ -87,7 +87,7 @@ Either just take a look at the [Rauthy Book](https://sebadob.github.io/rauthy/),
 the application yourself with docker on your localhost:
 
 ```
-docker run --rm -p 8080:8080 ghcr.io/sebadob/rauthy:0.16.0-lite
+docker run --rm -p 8080:8080 ghcr.io/sebadob/rauthy:0.17.0-lite
 ```
 
 **NOTE:**  

dev_notes.md

@@ -2,9 +2,6 @@
 
 ## CURRENT WORK
 
-- add integration tests for api keys an ip blacklisting
-- styling colors of checkboxes in ApiKey access matrix
-
 ## Stage 1 - essentials
 
 [x] finished

docs/getting_started/docker.html

@@ -7,7 +7,7 @@
 
 
         <!-- Custom HTML head -->
-        
+
         <meta name="description" content="">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="theme-color" content="#ffffff" />
@@ -152,7 +152,7 @@ <h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evalu
 <pre><code>docker run --rm \
     -p 8080:8080 \
     --name rauthy \
-    ghcr.io/sebadob/rauthy:0.16.0-lite
+    ghcr.io/sebadob/rauthy:0.17.0-lite
 </code></pre>
 <p>This will start the container in interactive mode with an in-memory SQLite database. Just take a look at the log at the
 logs to see the URL and first password.</p>
@@ -161,7 +161,7 @@ <h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evalu
     -e DATABASE_URL=sqlite:data/rauthy.db \
     -p 8080:8080 \
     --name rauthy \
-    ghcr.io/sebadob/rauthy:0.16.0-lite
+    ghcr.io/sebadob/rauthy:0.17.0-lite
 </code></pre>
 <div id="admonition-note" class="admonition note">
 <div class="admonition-title">
@@ -246,7 +246,7 @@ <h2 id="production-setup"><a class="header" href="#production-setup">Production
     -v $(pwd)/rauthy/data:/app/data \
     -p 8080:8080 \
     --name rauthy \
-    ghcr.io/sebadob/rauthy:0.16.0-lite
+    ghcr.io/sebadob/rauthy:0.17.0-lite
 </code></pre>
 <p><strong>6. Restrict DB files access even more</strong><br />
 After rauthy has done the first start, you could harden the access rights of the SQLite files even more.<br />

docs/getting_started/k8s.html

@@ -7,7 +7,7 @@
 
 
         <!-- Custom HTML head -->
-        
+
         <meta name="description" content="">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="theme-color" content="#ffffff" />
@@ -206,17 +206,17 @@ <h3 id="create-and-apply-secrets"><a class="header" href="#create-and-apply-secr
   # The CACHE_AUTH_TOKEN is only needed for a deployment with HA_MODE == true
   # Secret token, which is used to authenticate the cache members
   #CACHE_AUTH_TOKEN:
-  
+
   # The database driver will be chosen at runtime depending on the given DATABASE_URL format. Examples:
   # Sqlite: 'sqlite:data/rauthy.db' or 'sqlite::memory:'
   # Postgres: 'postgresql://User:PasswordWithoutSpecialCharacters@localhost:5432/DatabaseName'
-  DATABASE_URL: 
-    
+  DATABASE_URL:
+
   # Format: &quot;key_id/enc_key another_key_id/another_enc_key&quot; - the enc_key itself must be exactly 32 characters long and
   # and should not contain special characters.
   # The ID must match '[a-zA-Z0-9]{2,20}'
   ENC_KEYS:
-  
+
   # Needed for sending E-Mails for password resets and so on
   SMTP_PASSWORD:
 </code></pre>
@@ -292,7 +292,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
       containers:
         - name: rauthy
           # This example uses the version tag.
-          # In production, I would highly recommend to actually use SHA 
+          # In production, I would highly recommend to actually use SHA
           # hashes to prevent someone from overwriting the image tag on your possibly
           # own container registry with malicious content.
           #
@@ -306,9 +306,9 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
           #
           # Because of a chicken and egg problem, I cannot document the correct sha
           # hash for the latest version at this
-          # point. The latest image with the correct hash will always be shown for the 
+          # point. The latest image with the correct hash will always be shown for the
           # [Github Releases](https://github.com/sebadob/rauthy/releases)
-          image: ghcr.io/sebadob/rauthy:0.16.0-lite
+          image: ghcr.io/sebadob/rauthy:0.17.0-lite
           imagePullPolicy: IfNotPresent
           securityContext:
             # User ID 10001 is actually built into the container at the creation for
@@ -389,7 +389,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
               #memory:
               # A CPU limit may make sense in case of DDoS attacks or something
               # like this, if you do not have external rate limiting or other
-              # mechanisms. Otherwise, `MAX_HASH_THREADS` is the main mechanism 
+              # mechanisms. Otherwise, `MAX_HASH_THREADS` is the main mechanism
               # to limit resources.
               cpu: 1000m
       volumes: