Improving Documentation for Non-Containerized Environments #10711
Labels
area/documentation
contributor/wanted
Participation from an external contributor is highly requested
kind/enhancement
a new or improved feature.
priority/P3
maybe
Welcome!
What did you expect to see?
Hello Traefik Team,
I recently faced significant challenges while configuring Traefik directly on a Linux server without Docker. It took me many hours to discover that the file provider requires dynamic configuration for routing, which is not explicitly clear in the current documentation. After much debugging and searching through community questions such as on Stack Overflow, I found a community post that led me to realize the issue stemmed from placing route configurations in the static file.
This situation is particularly troublesome for users deploying Traefik directly on servers without container orchestration platforms like Docker or Kubernetes, where documentation is less abundant.
I propose to create a new section in the "Getting Started" guide titled "Getting Started with Linux Service." I am willing to author this documentation using MkDocs and submit a PR. I aim to discuss this topic here first to gather feedback and suggestions.
In this new documentation, I plan to cover:
How to install and configure Traefik on Ubuntu 24.
Steps to set up Traefik using the systemd service file available here.
A note explaining that when not using providers like Docker or Kubernetes, one should use the file provider, which requires all route configurations to be placed in the dynamic configuration file.
Unfortunately, there are no apt packages for Traefik, which would simplify the process further. However, I have created an Ansible role for this setup and can provide it as part of the example in the contrib directory.
I believe these additions will greatly aid users who are new to Traefik and are working in non-containerized environments.
Thank you for considering this enhancement to your documentation. I look forward to your feedback and am eager to contribute to making Traefik even more accessible.
The text was updated successfully, but these errors were encountered: