Skip to content

docs: add full working example tutorial in misc/deployment/ with link in intro #2225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 17, 2023
Merged

docs: add full working example tutorial in misc/deployment/ with link in intro #2225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fb2ab82
Added full working example on docs with link in intro
rela-v Jun 16, 2023
08f3cd6
fixed missing space
rela-v Jun 16, 2023
2f45cfb
Apply suggestions from code review
rela-v Jun 16, 2023
d40ecb6
added all suggested changes
rela-v Jun 16, 2023
3615068
per recommendation, added index.md in docs/misc/deployment/ with link…
rela-v Jun 16, 2023
3fd4add
added longer blurb
rela-v Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,8 @@ To apply changes made to the compose file, just run `docker compose up -d` again

Follow the logs of the container using `docker compose logs -f`, check on the status with `docker compose ps`, and stop the container using `docker compose stop`.

!!! note "Full Setup Example"
Here is a [reference guide to setting up a server from scratch using docker compose](misc/deployment/docker-compose-full-example/).

!!! note "More Examples"
There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
10 changes: 10 additions & 0 deletions docs/misc/deployment/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Supporting Articles

Below are supporting articles for server deployment.


- "Zero to Minecraft Server with Docker Desktop and Compose"

https://dev.to/rela-v/zero-to-minecraft-server-with-docker-desktop-and-compose-500a

- This is a reference guide/tutorial on how to set up a vanilla Minecraft server using this project, including step-by-step instructions, and information on topics such as port-forwarding.