tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2024-12-25 19:30:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
All Project Documentation
175 Commits 2 Branches 0 Tags 2.3 MiB
CSS 71.3%
HTML 17.8%
Dockerfile 10.9%
070c227c9d
Go to file
erentar 070c227c9d
intro: add curl example to add new video to download queue (#42) 
* intro: add curl example to add new video to download queue

* Revert "intro: add curl example to add new video to download queue"

This reverts commit 732d4c9a39.

* move curl add to queue example

* style code comment

---------

Co-authored-by: Simon <simobilleter@gmail.com>
2024-10-21 21:34:19 +07:00
mkdocs intro: add curl example to add new video to download queue (#42) 2024-10-21 21:34:19 +07: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-10-17 12:37:52 +07: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