Skip to content

Commit b61877c

Browse files
committed
forcepublish docs
1 parent fcf9529 commit b61877c

3 files changed

Lines changed: 17 additions & 8 deletions

File tree

Docs/admin/quickstart.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Admins quickstart guide!
2-
## Running NetEvent
2+
## Running NetEvent with docker
33

44
### Prerequirements
55

@@ -13,3 +13,9 @@
1313
- copy `.env.example` to `.env` and edit at least the `DBUser` and `DBPassword` values. Attention: DBPort does not change the port of the postgres instance that is configured by default in the compose file!
1414
- run `docker-compose up -d`
1515
- visit your NetEvent installation with your browser, login with Admin and Test123.. and configure your instance
16+
17+
### Notes
18+
19+
- You can find the container image on [Docker Hub](https://hub.docker.com/r/lan2play/netevent)
20+
- You can find the `Dockerfile` inside the root of our github repository and build it yourself
21+
- The container is intended to be running behind any kind of reverse proxy and therfore it is started with http only

Docs/index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# NetEvent
2+
3+
<!-- [![NetEvent_test_and_build](https://github.com/Lan2Play/NetEvent/actions/workflows/test_and_build.yml/badge.svg)](https://github.com/Lan2Play/NetEvent/actions/workflows/test_and_build.yml) -->
4+
25
<!-- <img alt="NetEvent Logo" src="logo.svg" width="50%"> -->
36

47
is an open source software solution for organizing events, especially focused on lan partys.
@@ -7,11 +10,11 @@ Its currently under heavy development, so only use it for testing or development
710

811

912
## Users quickstart notes:
10-
1. If you just want to use NetEvent as a user go to [Users guide](user/start.html)
11-
2. If you want to deploy NetEvent, please take a look into the [Quickstart Section of the Admins guide](admin/quickstart.html).
13+
- If you just want to use NetEvent as a user go to [Users guide](user/start.html)
14+
- If you want to deploy NetEvent, please take a look into the [Quickstart Section of the Admins guide](admin/quickstart.html).
1215

1316
## Developer notes:
14-
Github url: [https://github.com/Lan2Play/NetEvent](https://github.com/Lan2Play/NetEvent)
15-
17+
- Github url: [https://github.com/Lan2Play/NetEvent](https://github.com/Lan2Play/NetEvent)
18+
- If you want to contribute to NetEvent, please take a look into the [Developers guide](develop/quickstart.html).
1619

1720

Docs/toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
- name: Home
22
href: index.md
3-
- name: Users Guide
3+
- name: Users guide
44
href: user/
5-
- name: Admins Guide
5+
- name: Admins guide
66
href: admin/
7-
- name: Developers Guide
7+
- name: Developers guide
88
href: develop/

0 commit comments

Comments
 (0)