You can use this repo as a template for OAuth authentication using Axum and Google OAuth.
The underling database used is MongoDB. For a SQLite version using SQLx, see https://github.com/randommm/rust-axum-with-google-oauth.
Minijinja is also used as the HTML template system. Moreover, a deployment example with GitHub Actions is provided.
A live demo of this template is available at:
https://rust-oauth.marcoinacio.com/
-
Get an OAuth Client ID and key at https://console.cloud.google.com/apis/credentials, setup
http://localhost:3011/oauth_return
as an authorised redirect URI. -
Start a MongoDB instance, e.g. install mongo with your system package manager or with Docker
docker run --name mongo-server -p 27017:27017 -d mongo
-
Create file named
.env
at the root of the repository (same folder as the README.md), containing:DATABASE_URL="mongodb://localhost:27017/" GOOGLE_CLIENT_ID=your_google_oauth_id GOOGLE_CLIENT_SECRET=your_google_oauth_secret
-
If you don't have
Rust
installed, seehttps://rustup.rs
. -
Deploy with
cargo run --release
, then just browse your website athttp://localhost:3011
.
-
Get an OAuth Client ID and key at https://console.cloud.google.com/apis/credentials, setup
http://localhost:3011/oauth_return
as an authorised redirect URI. -
Create file named
.env
at the root of the repository (same folder as the README.md), containing:DATABASE_URL="mongodb://mongo-server/27017/" GOOGLE_CLIENT_ID=your_google_oauth_id GOOGLE_CLIENT_SECRET=your_google_oauth_secret
-
Build your OCI (Docker image) with
docker build -t ghcr.io/randommm/rust-axum-with-google-oauth .
. -
Deploy with
docker-compose up
, then just browse your website athttp://localhost:3011
.
-
Get an OAuth Client ID and key at https://console.cloud.google.com/apis/credentials, setup
http://localhost:3011/oauth_return
as an authorised redirect URI. -
Start a MongoDB instance:
docker run --name mongo-server -p 27017:27017 -d mongo
-
Build your OCI (Docker image) with
docker build -t ghcr.io/randommm/rust-axum-with-google-oauth .
. -
Deploy with
docker run --env DATABASE_URL="mongodb://127.0.0.1:27017/" --env GOOGLE_CLIENT_ID=your_google_oauth_id --env GOOGLE_CLIENT_SECRET=your_google_oauth_secret --rm -p 3011:3011 --net host ghcr.io/randommm/rust-axum-with-google-oauth
, then just browse your website athttp://localhost:3011
.
You can additional deploy on Nginx by adding the following to its configuration file (generally located at /etc/nginx/sites-available/default
):
server {
server_name youdomainname.com;
listen 80;
location / {
proxy_pass http://127.0.0.1:3011;
proxy_set_header Host $host;
}
}
Additionally, you can obtain an SSL certificate by running certbot --nginx
Generate a new token (classic) at https://github.com/settings/tokens/new with read:packages
permission. Login to the GH Docker registry at your server with docker login ghcr.io
.
Now, place docker-compose.yml
on your server along with the .env
and edit the docker-compose.yml
, change:
container_name: rust-axum-with-google-oauth
build:
context: .
to:
container_name: rust-axum-with-google-oauth
image: ghcr.io/put_your_github_username_here/rust-axum-with-google-oauth
Finally, edit your crontab (crontab -e
) to auto check, pull and deploy changes every 5 minutes:
*/5 * * * * cd /folder_where_docker-compose.yml_is_located/ && /usr/bin/docker-compose pull && /usr/bin/docker-compose up -d