All Project Documentation
Go to file
lamusmaser 738a0f0454
Merge pull request #40 from MerlinScheurer/add_notification_api
Add notification api
2024-05-13 08:12:32 -06:00
mkdocs Fix formatting 2024-05-13 14:56:39 +02:00
.gitignore ignore venv 2023-07-30 21:19:26 +07:00
Dockerfile update base image 2024-04-19 19:13:44 +02:00
LICENSE.md add LICENSE 2023-03-20 10:37:06 +07:00
README.md simplify dev instructions 2023-11-20 20:34:06 +07:00
requirements.txt bump requirements 2024-04-17 22:46:14 +02:00

README.md

Tube Archivist Documentation

docs.tubearchivist.com

This is the git repo of the official documentation for Tube Archivist - Your self hosted YouTube media server.

Additional links:

Make Changes

Please help improve these documentations. To make changes, fork this repo and make your changes. When you are ready, open a Pull Request. When merged, this will rebuild the live documentations within a few seconds.

Development Environment

To just make simple changes, edit the markdown files within mkdocs/docs direclty.

To setup a local development server:

Install requirements, e.g. with pip:

pip install -r requirements.txt

More details: User Guide

Run the server from the mkdocs folder with:

mkdocs serve

And the site - with live reload enabled - should be available on localhost:8000.

Production environment

Build the Docker image:

docker build -t bbilly1/tubearchivist-docs .

Run the image:

docker run -p 80:80 bbilly1/tubearchivist-docs