An open API service indexing awesome lists of open source software.

https://github.com/heyvaldemar/outline-keycloak-traefik-letsencrypt-docker-compose

Outline with Keycloak and Let's Encrypt Using Docker Compose
https://github.com/heyvaldemar/outline-keycloak-traefik-letsencrypt-docker-compose

devops docker docker-compose docker-container docker-hub dockerfile document-management keycloak keycloak-server letsencrypt letsencrypt-certificates minio minio-server minio-storage notion-alternative outline outline-server-manager productivity traefik yaml

Last synced: 25 days ago
JSON representation

Outline with Keycloak and Let's Encrypt Using Docker Compose

Awesome Lists containing this project

README

        

# Outline with Keycloak and Let's Encrypt Using Docker Compose

πŸ“™ The complete installation guide is available on my [website](https://www.heyvaldemar.com/install-outline-and-keycloak-using-docker-compose/).

❗ Change variables in the `.env` to meet your requirements.

πŸ’‘ Note that the `.env` file should be in the same directory as `01-traefik-outline-letsencrypt-docker-compose.yml`, `02-keycloak-outline-docker-compose.yml`, and `03-outline-minio-redis-docker-compose.yml`.

❗ The value for the `OUTLINE_OIDC_CLIENT_SECRET` variable can be obtained after installing Keycloak using `02-keycloak-outline-docker-compose.yml`.

❗ Additionally, you need to specify your values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET`.

The values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET` can be generated using the command:

`openssl rand -hex 32`

Create networks for your services before deploying the configuration using the commands:

`docker network create traefik-network`

`docker network create keycloak-network`

`docker network create outline-network`

Deploy Traefik using Docker Compose:

`docker compose -f 01-traefik-outline-letsencrypt-docker-compose.yml -p traefik up -d`

Deploy Keycloak using Docker Compose:

`docker compose -f 02-keycloak-outline-docker-compose.yml -p keycloak up -d`

Create a new `Realm` on Keycloak and name it `outline` (case sensitive).

Create a `Client` in the new realm and configure it:

1. Client type: `OpenID Connect`
2. Client ID: `outline` (case sensitive)
3. Client authentication: `on`
4. Authentication flow: uncheck all other options and leave only `Standard flow`
5. Set URLs:

- In the `Root URL` field, enter `https://outline.heyvaldemar.net/`
- In the `Home URL` field, enter `https://outline.heyvaldemar.net/`
- In the `Valid redirect URIs` field, enter `https://outline.heyvaldemar.net/*`

πŸ’‘ Please note, outline.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name, which points to the IP address of your server with the installed Traefik service, which will redirect the request to Outline.

Get a `Client secret` value on the `Credentials` tab of the `Client` that you created.

Specify the `OUTLINE_OIDC_CLIENT_SECRET` variable in the `.env`.

Create a user on Keycloak for Outline.

Note that you have to specify an email address and a username.

Set a password for the new user.

Deploy Keycloak using Docker Compose:

`docker compose -f 03-outline-minio-redis-docker-compose.yml -p outline up -d`

Log in to Outline with the Username or Email specified on the Keycloak.

## Author

hey everyone,

πŸ’Ύ I’ve been in the IT game for over 20 years, cutting my teeth with some big names like [IBM](https://www.linkedin.com/in/heyvaldemar/), [Thales](https://www.linkedin.com/in/heyvaldemar/), and [Amazon](https://www.linkedin.com/in/heyvaldemar/). These days, I wear the hat of a DevOps Consultant and Team Lead, but what really gets me going is Docker and container technology - I’m kind of obsessed!

πŸ’› I have my own IT [blog](https://www.heyvaldemar.com/), where I’ve built a [community](https://discord.gg/AJQGCCBcqf) of DevOps enthusiasts who share my love for all things Docker, containers, and IT technologies in general. And to make sure everyone can jump on this awesome DevOps train, I write super detailed guides (seriously, they’re foolproof!) that help even newbies deploy and manage complex IT solutions.

πŸš€ My dream is to empower every single person in the DevOps community to squeeze every last drop of potential out of Docker and container tech.

🐳 As a [Docker Captain](https://www.docker.com/captains/vladimir-mikhalev/), I’m stoked to share my knowledge, experiences, and a good dose of passion for the tech. My aim is to encourage learning, innovation, and growth, and to inspire the next generation of IT whizz-kids to push Docker and container tech to its limits.

Let’s do this together!

## My 2D Portfolio

πŸ•ΉοΈ Click into [sre.gg](https://www.sre.gg/) β€” my virtual space is a 2D pixel-art portfolio inviting you to interact with elements that encapsulate the milestones of my DevOps career.

## My Courses

πŸŽ“ Dive into my [comprehensive IT courses](https://www.heyvaldemar.com/courses/) designed for enthusiasts and professionals alike. Whether you're looking to master Docker, conquer Kubernetes, or advance your DevOps skills, my courses provide a structured pathway to enhancing your technical prowess.

πŸ”‘ [Each course](https://www.udemy.com/user/heyvaldemar/) is built from the ground up with real-world scenarios in mind, ensuring that you gain practical knowledge and hands-on experience. From beginners to seasoned professionals, there's something here for everyone to elevate their IT skills.

## My Services

πŸ’Ό Take a look at my [service catalog](https://www.heyvaldemar.com/services/) and find out how we can make your technological life better. Whether it's increasing the efficiency of your IT infrastructure, advancing your career, or expanding your technological horizons β€” I'm here to help you achieve your goals. From DevOps transformations to building gaming computers β€” let's make your technology unparalleled!

## Patreon Exclusives

πŸ† Join my [Patreon](https://www.patreon.com/heyvaldemar) and dive deep into the world of Docker and DevOps with exclusive content tailored for IT enthusiasts and professionals. As your experienced guide, I offer a range of membership tiers designed to suit everyone from newbies to IT experts.

## My Recommendations

πŸ“• Check out my collection of [essential DevOps books](https://kit.co/heyvaldemar/essential-devops-books)\
πŸ–₯️ Check out my [studio streaming and recording kit](https://kit.co/heyvaldemar/my-studio-streaming-and-recording-kit)\
πŸ“‘ Check out my [streaming starter kit](https://kit.co/heyvaldemar/streaming-starter-kit)

## Follow Me

🎬 [YouTube](https://www.youtube.com/channel/UCf85kQ0u1sYTTTyKVpxrlyQ?sub_confirmation=1)\
🐦 [X / Twitter](https://twitter.com/heyvaldemar)\
🎨 [Instagram](https://www.instagram.com/heyvaldemar/)\
🐘 [Mastodon](https://mastodon.social/@heyvaldemar)\
🧡 [Threads](https://www.threads.net/@heyvaldemar)\
🎸 [Facebook](https://www.facebook.com/heyvaldemarFB/)\
🧊 [Bluesky](https://bsky.app/profile/heyvaldemar.bsky.social)\
πŸŽ₯ [TikTok](https://www.tiktok.com/@heyvaldemar)\
πŸ’» [LinkedIn](https://www.linkedin.com/in/heyvaldemar/)\
πŸ“£ [daily.dev Squad](https://app.daily.dev/squads/devopscompass)\
🧩 [LeetCode](https://leetcode.com/u/heyvaldemar/)\
🐈 [GitHub](https://github.com/heyvaldemar)

## Community of IT Experts

πŸ‘Ύ [Discord](https://discord.gg/AJQGCCBcqf)

## Refill My Coffee Supplies

πŸ’– [PayPal](https://www.paypal.com/paypalme/heyvaldemarCOM)\
πŸ† [Patreon](https://www.patreon.com/heyvaldemar)\
πŸ’Ž [GitHub](https://github.com/sponsors/heyvaldemar)\
πŸ₯€ [BuyMeaCoffee](https://www.buymeacoffee.com/heyvaldemar)\
πŸͺ [Ko-fi](https://ko-fi.com/heyvaldemar)

🌟 **Bitcoin (BTC):** bc1q2fq0k2lvdythdrj4ep20metjwnjuf7wccpckxc\
πŸ”Ή **Ethereum (ETH):** 0x76C936F9366Fad39769CA5285b0Af1d975adacB8\
πŸͺ™ **Binance Coin (BNB):** bnb1xnn6gg63lr2dgufngfr0lkq39kz8qltjt2v2g6\
πŸ’  **Litecoin (LTC):** LMGrhx8Jsx73h1pWY9FE8GB46nBytjvz8g

### Show some πŸ’œ by starring some of the [repositories](https://github.com/heyValdemar?tab=repositories)!

![octocat](https://user-images.githubusercontent.com/10498744/210113490-e2fad07f-4488-4da8-a656-b9abbdd8cb26.gif)

![footer](https://user-images.githubusercontent.com/10498744/210157572-1fca0242-8af2-46a6-bfa3-666ffd40ebde.svg)