mirror of
https://github.com/tubearchivist/docs.git
synced 2025-06-03 11:01:09 +00:00
2ea97f67c2
* Update unraid Instructions update for v0.5.0+ changes, plus fixing a few broken links * Delete mkdocs/docs/assets/unraid_redis_port.png TA v0.5.0+ no longer uses the REDIS_PORT env variable. * update unraid redis image Updated unraid redis install screenshot per v0.5.0+ * update unraid ta container screenshot per v0.5.0 changes, show redis connection string. * Update unraid.md fix image/text wraparound * fix unraid relative links
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:
- The Project: tubearchivist/tubearchivist
- The Website: tubearchivist.com
- The Discord: tubearchivist.com/discord
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 directly.
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