pterodactyl / pterodactyl/documentation

Add docker-compose as an installation method to the docs

Open
#457 4 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Vue
Stars
198
Forks
2.2k
PR merge metrics
No merged PRs in 30d

Description

Adding docker-compose as a method of installation to the documentation could be a great way to install the panel for the less technically inclined people, who would otherwise use scripts and clog up the support channels.

Currently, only people who know what they are looking for would use the images, and they are people who could install the panel normally anyway, which isn't really taking full advantage of the utility of docker containers

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing installation documentation and the repository's Docker image guidance. Add a documented docker-compose installation method for the panel, including the steps needed for a less technically inclined user, and verify that the instructions are complete and reproducible.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.