From 528938942a696f8d544df85ed1d0ecbc7b5855a6 Mon Sep 17 00:00:00 2001 From: simon Date: Sun, 17 Oct 2021 11:31:21 +0700 Subject: [PATCH] update docs for v0.0.6 take 2 --- README.md | 12 +++++++++--- docker-compose.yml | 2 +- docs/Home.md | 5 +---- tubearchivist/home/templates/home/base.html | 2 +- tubearchivist/requirements.txt | 2 +- 5 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a4ab809..91bcb86 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,15 @@ For some architectures it might be required to run Redis JSON on a nonstandard p ### Updating Tube Archivist You will see the current version number of **Tube Archivist** in the footer of the interface so you can compare it with the latest release to make sure you are running the *latest and greatest*. -* There can be breaking changes between updates, particularly as the application grows, new environment variables or settings might be required for you to set in the your docker-compose file. Any breaking changes will be marked in the **release notes**. +* There can be breaking changes between updates, particularly as the application grows, new environment variables or settings might be required for you to set in the your docker-compose file. *Always* check the **release notes**: Any breaking changes will be marked there. * All testing and development is done with the Elasticsearch version number as mentioned in the provided *docker-compose.yml* file. This will be updated when a new release of Elasticsearch is available. Running an older version of Elasticsearch is most likely not going to result in any issues, but it's still recommended to run the same version as mentioned. +### Alternative installation instructions: +- **arm64**: Newest Tube Archivist container is multi arch, so is Elasticsearch. RedisJSON doesn't offer arm builds, you can use `bbilly1/rejson`, an unofficial rebuild for arm64. + - NOTE: This is untested, looking for feedback. +- **Synology**: There is a [discussion thread](https://github.com/bbilly1/tubearchivist/discussions/48) with Synology installation instructions. +- **Unraid**: There is a [template](https://github.com/pairofcrocs/unraid-templates/) and forum [thread](https://forums.unraid.net/topic/114073-support-crocs-tube-archivist/) with additional information. + ## Potential pitfalls ### vm.max_map_count **Elastic Search** in Docker requires the kernel setting of the host machine `vm.max_map_count` to be set to at least 262144. @@ -111,11 +117,11 @@ This should be considered as a **minimal viable product**, there is an extensive ### Functionality - [ ] Access control - [ ] User roles -- [ ] Delete videos and channel - [ ] Create playlists - [ ] Podcast mode to serve channel as mp3 - [ ] Implement [PyFilesystem](https://github.com/PyFilesystem/pyfilesystem2) for flexible video storage -- [ ] Add thumbnail embed option +- [X] Delete videos and channel [2021-10-16] +- [X] Add thumbnail embed option [2021-10-16] - [X] Un-ignore videos [2021-10-03] - [X] Dynamic download queue [2021-09-26] - [X] Backup and restore [2021-09-22] diff --git a/docker-compose.yml b/docker-compose.yml index 687cd53..356fc8d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -29,7 +29,7 @@ services: depends_on: - archivist-es archivist-es: - image: docker.elastic.co/elasticsearch/elasticsearch:7.15.0 + image: docker.elastic.co/elasticsearch/elasticsearch:7.15.1 container_name: archivist-es restart: always environment: diff --git a/docs/Home.md b/docs/Home.md index 8cf885d..151e379 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -1,7 +1,4 @@ # Tube Archivist Wiki - -**WIP**: This is work in progress! - Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality. Table of contents: @@ -24,6 +21,6 @@ Table of contents: * Hover over the playing video to show additional control options. -An empty checkbox icon unseen icon will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox seen icon indicating it as watched. +An empty checkbox icon unseen icon will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox seen icon indicating it as watched - click again to revert. When available the gridview icon gridview icon will display the list in a grid, the listview icon listview icon will arrange the items in a list. diff --git a/tubearchivist/home/templates/home/base.html b/tubearchivist/home/templates/home/base.html index c23bc78..dab53f3 100644 --- a/tubearchivist/home/templates/home/base.html +++ b/tubearchivist/home/templates/home/base.html @@ -96,7 +96,7 @@
- © 2021 The Tube Archivist v0.0.5 | Github | Docker Hub + © 2021 The Tube Archivist v0.0.6 | Github | Docker Hub
diff --git a/tubearchivist/requirements.txt b/tubearchivist/requirements.txt index edf9a79..127f8fa 100644 --- a/tubearchivist/requirements.txt +++ b/tubearchivist/requirements.txt @@ -1,7 +1,7 @@ beautifulsoup4==4.10.0 celery==5.1.2 Django==3.2.8 -Pillow==8.3.2 +Pillow==8.4.0 redis==3.5.3 requests==2.26.0 uWSGI==2.0.20