Homeserver/docs
1
0
Fork 0
generated from Homeserver/template
Code Issues Projects Releases Packages Activity Actions
Markdown documentation of the self-hosted homeserver
3 commits 1 branch 0 tags 34 KiB
Find a file
Exact
Lukas Gysin 671911f082
 feat: Install MkDocs
2025-09-23 11:41:39 +02:00
docs feat: Install MkDocs 2025-09-23 11:41:39 +02:00
.env.example feat: Install MkDocs 2025-09-23 11:41:39 +02:00
.gitignore Initial commit 2025-09-23 09:15:49 +02:00
CODE_OF_CONDUCT Initial commit 2025-09-23 09:15:49 +02:00
docker-compose.yaml feat: Install MkDocs 2025-09-23 11:41:39 +02:00
Dockerfile feat: Install MkDocs 2025-09-23 11:41:39 +02:00
LICENSE Initial commit 2025-09-23 09:15:49 +02:00
mkdocs.yml feat: Install MkDocs 2025-09-23 11:41:39 +02:00
README.md feat: Install MkDocs 2025-09-23 11:41:39 +02:00

README.md

Documentation

Markdown documentation of the self-hosted homeserver.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Requirements for the software and other tools to build, test and push

Supported IDEs

You can use the IDE of your choice to continue developing the project. However, the following IDEs are recommended and officially supported:

Secret Management

Sensitive data is stored in a .env file. An empty example of the structure can be found in .env.example

Docker Image

For this application to work, the docker image must be build. In this steps, the Markdown documentation is compiled by mkdocs to HTML. Then the compiled documentation is exposed as a webpage.

docker build --tag homeserver/docs:latest .

Development

This repository is a full functional docker compose application stack. Therefore, you can use the terminal to deploy a development instance on your local machine.

docker build --tag homeserver/docs:latest .
docker-compose up -d

Deployment

For the deployment, the docker compose stack must be copied to the server and started

ssh $USER@$SERVER "docker compose -f $PATH/docker-compose.yaml down"
scp mkdocs.yml $USER@$SERVER:/$PATH/
scp -r docs $USER@$SERVER:/$PATH/
scp Dockerfile $USER@$SERVER:/$PATH/
ssh $USER@$SERVER "cd $PATH && docker build --tag homeserver/docs:latest ."
scp .env $USER@$SERVER:/$PATH/
scp  docker-compose.yaml $USER@$SERVER:/$PATH/
ssh $USER@$SERVER "docker compose -f $PATH/docker-compose.yaml up -d"

The $USER variable holds the username of the user on the server.
The $SERVER variable holds the IP-address or the domain of the server.
The $PATH variable holds the absolut path to the application folder on the server.

Authors

License

This project is licensed under the MIT License

Acknowledgments