Set up GitHub
Time Required
10 Minutes
Difficulty
Low
Set up your Repo
Create a Private Repo
If you have a pre-existing repo you wish to use, skip the creation part.
Follow GitHubs documentation on creating a repo
Ensure Repo is Private
Ensure your repo is set to private, or switch it to private
Somethings to think about
Private vs Public repo
I would recommend creating a Private repo so you can store private information, such as API keys in it.
If you're going to obfuscate your files with variables or secrets (which you will need to store elsewhere), you could make the repo Public. But in my opinion, its better to be safe than sorry.
Please note that the version history is also public, so if you accidentally save a password or API key its saved forever.
What to name your repo
Your repo should be named something you remember and unique to you. It doesn't really matter though. I would suggest something short so your repo url is short
Create a Private Access Token for Portainer
As your repo is private, you will need to create a PAC for Portainer to use and access the repo
Click on your profile in the top right, then select Settings
On the left, click on Developer Settings
Click on Personal Access Tokens, then 'Tokens (classic)'
Click on 'Generate new token', then select 'Classic'
Input the below information\
Scroll down and click on 'Generate Token'
Save your PAC somewhere safe and smart
Install Renovate Bot
The Renovate Bot watches for dependancies and automatically creates merge requests to update the contents of your Repo. This allows you to update your containers outside of Portainer as well as review changes made etc.
Get your Repo ready
Create a folder '.github' in the root of your repo
Create a folder 'docker-compose' in the root of your repo
In the '.github' folder, create a file 'renovate.json5' with the below contents
This code block tells the bot to watch any '.yml' or '.yaml' file in the 'docker-compose' folder
Install the Bot
Follow this link to install the bot
You can set renovate to run on all repo's you own, or only your repo created in this doco This is up to you. If you actually use GitHub for development, it may be best to select only this repo
Confirm the bot is installed
Browse to your GitHub repo
Last updated