Running GitLab MkDocs repository with Docker

Hi all,

I want to create an MkDocs site for my team to write and access documentation. It’s supposed to be simple, but I’ve spent hours on it and just lost track, unable to make any progress. I would really appreciate some help!

I’m new to GitLab (and GitHub), and I’ve been using Linux/Docker for a few months, but I’m still a beginner.

Problem to Solve

My plan is to use Material for MkDocs to create my website and host it in a Docker container. I already have a VM (Debian) with Docker and Portainer, along with a few apps running. I also have a domain name and Traefik as a proxy. I want the website content to be easily editable via GitLab.

I’m trying to use GitLab runners to run my project (example), but I don’t understand how Runners work. I don’t want to execute the runner on my laptop to generate the website locally. Ideally, I want to run it on my Docker (with a docker-compose file under Portainer) and access it on the internet under my domain name.

Am I overcomplicating things, or am I missing something?

Can someone guide me?

I’ve spent a day looking for solutions but haven’t found a tutorial or easy explanations.

Configuration

Hi @ndeschamps-isto

It looks like you are not using gitlab.com (Saas) - is that correct? Do you have GitLab Pages enabled on your self-hosted instance?

I would like to help you! I’m a community expert in the mkdocs-material project :wink:

Greedings
Niclas

@ndeschamps-isto

Please post your question in mkdocs-material discussion forum