You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: 01-traefik-outline-letsencrypt-docker-compose.yml
+33-140
Original file line number
Diff line number
Diff line change
@@ -1,131 +1,3 @@
1
-
# Outline with Keycloak and Let's Encrypt Using Docker Compose
2
-
3
-
# The complete installation guide is available on my website https://www.heyvaldemar.com/install-outline-and-keycloak-using-docker-compose/
4
-
5
-
# Change variables in the `.env` to meet your requirements.
6
-
# 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`.
7
-
8
-
# The value for the `OUTLINE_OIDC_CLIENT_SECRET` variable can be obtained after installing Keycloak using `02-keycloak-outline-docker-compose.yml`.
9
-
10
-
# Additionally, you need to specify your values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET`.
11
-
# The values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET` can be generated using the command:
12
-
# `openssl rand -hex 32`
13
-
14
-
# Create networks for your services before deploying the configuration using the commands:
15
-
# `docker network create traefik-network`
16
-
# `docker network create keycloak-network`
17
-
# `docker network create outline-network`
18
-
19
-
# Deploy Traefik using Docker Compose:
20
-
# `docker compose -f 01-traefik-outline-letsencrypt-docker-compose.yml -p traefik up -d`
21
-
22
-
# Deploy Keycloak using Docker Compose:
23
-
# `docker compose -f 02-keycloak-outline-docker-compose.yml -p keycloak up -d`
24
-
25
-
# Create a new `Realm` on Keycloak and name it `outline` (case sensitive).
26
-
27
-
# Create a `Client` in the new realm and configure it:
28
-
# 1. Client type: `OpenID Connect`
29
-
# 2. Client ID: `outline` (case sensitive)
30
-
# 3. Client authentication: `on`
31
-
# 4. Authentication flow: uncheck all other options and leave only `Standard flow`
32
-
# 5. Set URLs:
33
-
# - In the `Root URL` field, enter `https://outline.heyvaldemar.net/`
34
-
# - In the `Home URL` field, enter `https://outline.heyvaldemar.net/`
35
-
# - In the `Valid redirect URIs` field, enter `https://outline.heyvaldemar.net/*`
36
-
37
-
# Please note, outline.heyvaldemar.net is the domain name of my service.
38
-
# Accordingly, you need to specify your domain name,
39
-
# which points to the IP address of your server with the installed Traefik service,
40
-
# which will redirect the request to Outline.
41
-
42
-
# Get a `Client secret` value on the `Credentials` tab of the `Client` that you created.
43
-
# Specify the `OUTLINE_OIDC_CLIENT_SECRET` variable in the `.env`.
44
-
45
-
# Create a user on Keycloak for Outline.
46
-
# Note that you have to specify an email address and a username.
47
-
# Set a password for the new user.
48
-
49
-
# Deploy Keycloak using Docker Compose:
50
-
# `docker compose -f 03-outline-minio-redis-docker-compose.yml -p outline up -d`
51
-
52
-
# Log in to Outline with the Username or Email specified on the Keycloak.
53
-
54
-
# Backups
55
-
# The `backups-keycloak` container in the configuration is responsible for the following:
56
-
# 1. **Database Backup**: Creates compressed backups of the PostgreSQL database using pg_dump.
57
-
# Customizable backup path, filename pattern, and schedule through variables like `KEYCLOAK_POSTGRES_BACKUPS_PATH`, `KEYCLOAK_POSTGRES_BACKUP_NAME`, and `KEYCLOAK_BACKUP_INTERVAL`.
58
-
# 2. **Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `KEYCLOAK_POSTGRES_BACKUP_PRUNE_DAYS`.
59
-
60
-
# The `backups-outline` container in the configuration is responsible for the following:
61
-
# 1. **Application Data Backup**: Compresses and stores backups of the application data on the same schedule. Controlled via variables such as `OUTLINE_DATA_BACKUPS_PATH`, `OUTLINE_DATA_BACKUP_NAME`, and `OUTLINE_BACKUP_INTERVAL`.
62
-
# 2. **Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `OUTLINE_DATA_BACKUP_PRUNE_DAYS`.
63
-
# By utilizing these containers, consistent and automated backups of the essential components of your instance are ensured.
64
-
# Moreover, efficient management of backup storage and tailored backup routines can be achieved through easy and flexible configuration using environment variables.
65
-
66
-
# # keycloak-restore-database.sh Description
67
-
# This script facilitates the restoration of a database backup:
68
-
# 1. **Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
69
-
# 2. **List Backups**: Displays all available database backups located at the specified backup path.
70
-
# 3. **Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
71
-
# 4. **Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
72
-
# 5. **Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
73
-
# 6. **Start Service**: Restarts the service after the restoration is completed.
74
-
# To make the `keycloak-restore-database.sh` script executable, run the following command:
75
-
# `chmod +x keycloak-restore-database.sh`
76
-
# Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
77
-
78
-
# # outline-restore-database.sh Description
79
-
# This script facilitates the restoration of a database backup:
80
-
# 1. **Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
81
-
# 2. **List Backups**: Displays all available database backups located at the specified backup path.
82
-
# 3. **Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
83
-
# 4. **Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
84
-
# 5. **Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
85
-
# 6. **Start Service**: Restarts the service after the restoration is completed.
86
-
# To make the `outline-restore-database.sh` script executable, run the following command:
87
-
# `chmod +x outline-restore-database.sh`
88
-
# Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
# This script is designed to restore the application data:
92
-
# 1. **Identify Containers**: Similarly to the database restore script, it identifies the service and backups containers by name.
93
-
# 2. **List Application Data Backups**: Displays all available application data backups at the specified backup path.
94
-
# 3. **Select Backup**: Asks the user to copy and paste the desired backup name for application data restoration.
95
-
# 4. **Stop Service**: Stops the service to prevent any conflicts during the restore process.
96
-
# 5. **Restore Application Data**: Removes the current application data and then extracts the selected backup to the appropriate application data path.
97
-
# 6. **Start Service**: Restarts the service after the application data has been successfully restored.
98
-
# To make the `outline-restore-application-data.sh` script executable, run the following command:
99
-
# `chmod +x outline-restore-application-data.sh`
100
-
# By utilizing this script, you can efficiently restore application data from an existing backup while ensuring proper coordination with the running service.
101
-
102
-
# Author
103
-
# I’m Vladimir Mikhalev, the Docker Captain, but my friends can call me Valdemar.
Copy file name to clipboardexpand all lines: 03-outline-minio-redis-docker-compose.yml
+30-128
Original file line number
Diff line number
Diff line change
@@ -1,131 +1,3 @@
1
-
# Outline with Keycloak and Let's Encrypt Using Docker Compose
2
-
3
-
# The complete installation guide is available on my website https://www.heyvaldemar.com/install-outline-and-keycloak-using-docker-compose/
4
-
5
-
# Change variables in the `.env` to meet your requirements.
6
-
# 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`.
7
-
8
-
# The value for the `OUTLINE_OIDC_CLIENT_SECRET` variable can be obtained after installing Keycloak using `02-keycloak-outline-docker-compose.yml`.
9
-
10
-
# Additionally, you need to specify your values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET`.
11
-
# The values for `OUTLINE_SECRET_KEY` and `OUTLINE_UTILS_SECRET` can be generated using the command:
12
-
# `openssl rand -hex 32`
13
-
14
-
# Create networks for your services before deploying the configuration using the commands:
15
-
# `docker network create traefik-network`
16
-
# `docker network create keycloak-network`
17
-
# `docker network create outline-network`
18
-
19
-
# Deploy Traefik using Docker Compose:
20
-
# `docker compose -f 01-traefik-outline-letsencrypt-docker-compose.yml -p traefik up -d`
21
-
22
-
# Deploy Keycloak using Docker Compose:
23
-
# `docker compose -f 02-keycloak-outline-docker-compose.yml -p keycloak up -d`
24
-
25
-
# Create a new `Realm` on Keycloak and name it `outline` (case sensitive).
26
-
27
-
# Create a `Client` in the new realm and configure it:
28
-
# 1. Client type: `OpenID Connect`
29
-
# 2. Client ID: `outline` (case sensitive)
30
-
# 3. Client authentication: `on`
31
-
# 4. Authentication flow: uncheck all other options and leave only `Standard flow`
32
-
# 5. Set URLs:
33
-
# - In the `Root URL` field, enter `https://outline.heyvaldemar.net/`
34
-
# - In the `Home URL` field, enter `https://outline.heyvaldemar.net/`
35
-
# - In the `Valid redirect URIs` field, enter `https://outline.heyvaldemar.net/*`
36
-
37
-
# Please note, outline.heyvaldemar.net is the domain name of my service.
38
-
# Accordingly, you need to specify your domain name,
39
-
# which points to the IP address of your server with the installed Traefik service,
40
-
# which will redirect the request to Outline.
41
-
42
-
# Get a `Client secret` value on the `Credentials` tab of the `Client` that you created.
43
-
# Specify the `OUTLINE_OIDC_CLIENT_SECRET` variable in the `.env`.
44
-
45
-
# Create a user on Keycloak for Outline.
46
-
# Note that you have to specify an email address and a username.
47
-
# Set a password for the new user.
48
-
49
-
# Deploy Keycloak using Docker Compose:
50
-
# `docker compose -f 03-outline-minio-redis-docker-compose.yml -p outline up -d`
51
-
52
-
# Log in to Outline with the Username or Email specified on the Keycloak.
53
-
54
-
# Backups
55
-
# The `backups-keycloak` container in the configuration is responsible for the following:
56
-
# 1. **Database Backup**: Creates compressed backups of the PostgreSQL database using pg_dump.
57
-
# Customizable backup path, filename pattern, and schedule through variables like `KEYCLOAK_POSTGRES_BACKUPS_PATH`, `KEYCLOAK_POSTGRES_BACKUP_NAME`, and `KEYCLOAK_BACKUP_INTERVAL`.
58
-
# 2. **Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `KEYCLOAK_POSTGRES_BACKUP_PRUNE_DAYS`.
59
-
60
-
# The `backups-outline` container in the configuration is responsible for the following:
61
-
# 1. **Application Data Backup**: Compresses and stores backups of the application data on the same schedule. Controlled via variables such as `OUTLINE_DATA_BACKUPS_PATH`, `OUTLINE_DATA_BACKUP_NAME`, and `OUTLINE_BACKUP_INTERVAL`.
62
-
# 2. **Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `OUTLINE_DATA_BACKUP_PRUNE_DAYS`.
63
-
# By utilizing these containers, consistent and automated backups of the essential components of your instance are ensured.
64
-
# Moreover, efficient management of backup storage and tailored backup routines can be achieved through easy and flexible configuration using environment variables.
65
-
66
-
# # keycloak-restore-database.sh Description
67
-
# This script facilitates the restoration of a database backup:
68
-
# 1. **Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
69
-
# 2. **List Backups**: Displays all available database backups located at the specified backup path.
70
-
# 3. **Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
71
-
# 4. **Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
72
-
# 5. **Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
73
-
# 6. **Start Service**: Restarts the service after the restoration is completed.
74
-
# To make the `keycloak-restore-database.sh` script executable, run the following command:
75
-
# `chmod +x keycloak-restore-database.sh`
76
-
# Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
77
-
78
-
# # outline-restore-database.sh Description
79
-
# This script facilitates the restoration of a database backup:
80
-
# 1. **Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
81
-
# 2. **List Backups**: Displays all available database backups located at the specified backup path.
82
-
# 3. **Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
83
-
# 4. **Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
84
-
# 5. **Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
85
-
# 6. **Start Service**: Restarts the service after the restoration is completed.
86
-
# To make the `outline-restore-database.sh` script executable, run the following command:
87
-
# `chmod +x outline-restore-database.sh`
88
-
# Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
# This script is designed to restore the application data:
92
-
# 1. **Identify Containers**: Similarly to the database restore script, it identifies the service and backups containers by name.
93
-
# 2. **List Application Data Backups**: Displays all available application data backups at the specified backup path.
94
-
# 3. **Select Backup**: Asks the user to copy and paste the desired backup name for application data restoration.
95
-
# 4. **Stop Service**: Stops the service to prevent any conflicts during the restore process.
96
-
# 5. **Restore Application Data**: Removes the current application data and then extracts the selected backup to the appropriate application data path.
97
-
# 6. **Start Service**: Restarts the service after the application data has been successfully restored.
98
-
# To make the `outline-restore-application-data.sh` script executable, run the following command:
99
-
# `chmod +x outline-restore-application-data.sh`
100
-
# By utilizing this script, you can efficiently restore application data from an existing backup while ensuring proper coordination with the running service.
101
-
102
-
# Author
103
-
# I’m Vladimir Mikhalev, the Docker Captain, but my friends can call me Valdemar.
The badge displayed on my repository indicates the status of the deployment verification workflow as executed on the latest commit to the main branch.
6
-
7
-
**Passing**: This means the most recent commit has successfully passed all deployment checks, confirming that the Docker Compose setup functions correctly as designed.
8
-
9
3
📙 The complete installation guide is available on my [website](https://www.heyvaldemar.com/install-outline-and-keycloak-using-docker-compose/).
10
4
11
5
❗ Change variables in the `.env` to meet your requirements.
@@ -68,114 +62,82 @@ Deploy Keycloak using Docker Compose:
68
62
69
63
Log in to Outline with the Username or Email specified on the Keycloak.
70
64
71
-
# Backups
72
-
73
-
The `backups-keycloak` container in the configuration is responsible for the following:
74
-
75
-
1.**Database Backup**: Creates compressed backups of the PostgreSQL database using pg_dump.
76
-
Customizable backup path, filename pattern, and schedule through variables like `KEYCLOAK_POSTGRES_BACKUPS_PATH`, `KEYCLOAK_POSTGRES_BACKUP_NAME`, and `KEYCLOAK_BACKUP_INTERVAL`.
77
-
78
-
2.**Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `KEYCLOAK_POSTGRES_BACKUP_PRUNE_DAYS`.
79
-
80
-
The `backups-outline` container in the configuration is responsible for the following:
81
-
82
-
1.**Application Data Backup**: Compresses and stores backups of the application data on the same schedule. Controlled via variables such as `OUTLINE_DATA_BACKUPS_PATH`, `OUTLINE_DATA_BACKUP_NAME`, and `OUTLINE_BACKUP_INTERVAL`.
83
-
84
-
2.**Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage. Customizable pruning schedule and age threshold with `OUTLINE_DATA_BACKUP_PRUNE_DAYS`.
85
-
86
-
By utilizing these containers, consistent and automated backups of the essential components of your instance are ensured. Moreover, efficient management of backup storage and tailored backup routines can be achieved through easy and flexible configuration using environment variables.
87
-
88
-
# keycloak-restore-database.sh Description
89
-
90
-
This script facilitates the restoration of a database backup:
91
-
92
-
1.**Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
93
-
94
-
2.**List Backups**: Displays all available database backups located at the specified backup path.
95
-
96
-
3.**Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
97
-
98
-
4.**Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
99
-
100
-
5.**Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
101
-
102
-
6.**Start Service**: Restarts the service after the restoration is completed.
103
-
104
-
To make the `keycloak-restore-database.shh` script executable, run the following command:
105
-
106
-
`chmod +x keycloak-restore-database.sh`
107
-
108
-
Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
65
+
## Author
109
66
110
-
# outline-restore-database.sh Description
67
+
hey everyone,
111
68
112
-
This script facilitates the restoration of a database backup:
69
+
💾 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!
113
70
114
-
1.**Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
71
+
💛 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.
115
72
116
-
2.**List Backups**: Displays all available database backups located at the specified backup path.
73
+
🚀 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.
117
74
118
-
3.**Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
75
+
🐳 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.
119
76
120
-
4.**Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
77
+
Let’s do this together!
121
78
122
-
5.**Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
79
+
## My 2D Portfolio
123
80
124
-
6.**Start Service**: Restarts the service after the restoration is completed.
81
+
🕹️ 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.
125
82
126
-
To make the `outline-restore-database.shh` script executable, run the following command:
83
+
## My Courses
127
84
128
-
`chmod +x outline-restore-database.sh`
85
+
🎓 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.
129
86
130
-
Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
87
+
🔑 [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.
131
88
132
-
#outline-restore-application-data.sh Description
89
+
## My Services
133
90
134
-
This script is designed to restore the application data:
91
+
💼 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!
135
92
136
-
1.**Identify Containers**: Similarly to the database restore script, it identifies the service and backups containers by name.
93
+
## Patreon Exclusives
137
94
138
-
2.**List Application Data Backups**: Displays all available application data backups at the specified backup path.
95
+
🏆 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.
139
96
140
-
3.**Select Backup**: Asks the user to copy and paste the desired backup name for application data restoration.
97
+
## My Recommendations
141
98
142
-
4.**Stop Service**: Stops the service to prevent any conflicts during the restore process.
99
+
📕 Check out my collection of [essential DevOps books](https://kit.co/heyvaldemar/essential-devops-books)\
100
+
🖥️ Check out my [studio streaming and recording kit](https://kit.co/heyvaldemar/my-studio-streaming-and-recording-kit)\
101
+
📡 Check out my [streaming starter kit](https://kit.co/heyvaldemar/streaming-starter-kit)
143
102
144
-
5.**Restore Application Data**: Removes the current application data and then extracts the selected backup to the appropriate application data path.
103
+
## Follow Me
145
104
146
-
6.**Start Service**: Restarts the service after the application data has been successfully restored.
To make the `outline-restore-application-data.sh` script executable, run the following command:
118
+
## Community of IT Experts
149
119
150
-
`chmod +x outline-restore-application-data.sh`
120
+
👾 [Discord](https://discord.gg/AJQGCCBcqf)
151
121
152
-
By utilizing this script, you can efficiently restore application data from an existing backup while ensuring proper coordination with the running service.
0 commit comments