nm3clol/nm3clol-express-app
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: nm3clol:c7b3e5fb9cf0cb04cb7945c926c0465eb723e057
Branches Tags
nm3clol:main
..
compare: nm3clol:b4eaac03a9599c9f3b862a2f06f48c3142a85a4f
Branches Tags
nm3clol:main

1 Commits
c7b3e5fb9c ... b4eaac03a9

Author SHA1 Message Date
David Ball
b4eaac03a9 Updated scripts, YouTube cookies example, docker compose configuration, and documentation. 2024-05-24 03:22:51 -04:00
2 changed files with 10 additions and 25 deletions
Show Stats Expand all files Collapse all files

15
LICENSE
View File

@ -1,15 +0,0 @@
No Moss 3 Carbo Landfill Online Library
Copyright (C) 2024 David A. Ball <david@daball.me>.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

20
README.md
View File

@ -8,7 +8,7 @@ Microsoft Documentation: [https://learn.microsoft.com/en-us/devops/develop/git/i
Git SCM Downloads: [https://git-scm.com/downloads](https://git-scm.com/downloads) Git SCM Downloads: [https://git-scm.com/downloads](https://git-scm.com/downloads)
# Installing Git LFS # Install Git LFS
This enables the large file storage system. It needs to be done once per user account that uses it. This enables the large file storage system. It needs to be done once per user account that uses it.
@ -28,19 +28,19 @@ From inside the working directory, you can use git to pull source updates from t
git pull git pull
# Pulling Git LFS Updates # Download Git LFS
From inside the working directory, download all the large file storage updates from the origin server. From inside the working directory, download all the large file storage updates from the origin server.
git lfs pull git lfs pull
# Installing Docker and Docker Compose (optional) # Install Docker and Docker Compose (optional)
Installing Docker is beyond the scope of this document. You may choose to install Docker to simplify running this web site. Installing Docker is beyond the scope of this document. You may choose to install Docker to simplify running this web site.
[https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
# Installing Solr with Tika and Tesseract # Install Solr with Tika and Tesseract
Installing Solr with Tika and Tesseract is beyond the scope of this document. It is the search engine I am currently using. Installing Solr with Tika and Tesseract is beyond the scope of this document. It is the search engine I am currently using.
@ -61,13 +61,13 @@ Tika Test URL: [http://localhost:9998/](http://localhost:9998/)
In case of trouble with accessing them from outside the localhost, please check and ensure the exposed Solr port is allowed through your firewall for the web server host to access. Please permit the Tika and the Solr port through your firewall in order to for any npm workers to request the plaintext for documents. In case of trouble with accessing them from outside the localhost, please check and ensure the exposed Solr port is allowed through your firewall for the web server host to access. Please permit the Tika and the Solr port through your firewall in order to for any npm workers to request the plaintext for documents.
# Installing ffmpeg # `yt-dlp` Pre-requisite: ffmpeg
Before you can re-encode the yt-dlp output, you will need to install ffmpeg and have the `ffmpeg` binary available in your `PATH`. Before you can re-encode the yt-dlp output, you will need to install ffmpeg and have the `ffmpeg` binary available in your `PATH`.
[https://ffmpeg.org/download.html](https://ffmpeg.org/download.html) [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html)
# Installing yt-dlp # Required: `yt-dlp`
You need to install yt-dlp and have the binary `yt-dlp` binary available in your `PATH`. You need to install yt-dlp and have the binary `yt-dlp` binary available in your `PATH`.
@ -77,7 +77,7 @@ Standalone Binaries: [https://github.com/yt-dlp/yt-dlp#release-files](https://gi
Installation: [https://github.com/yt-dlp/yt-dlp/wiki/Installation](https://github.com/yt-dlp/yt-dlp/wiki/Installation) Installation: [https://github.com/yt-dlp/yt-dlp/wiki/Installation](https://github.com/yt-dlp/yt-dlp/wiki/Installation)
# *Windows*: Reloading Environment # *Windows*: Reload Environment
In Windows you will need to log out and back in after updating your environment variables. In PowerShell you can reload your `PATH` environment variable using: In Windows you will need to log out and back in after updating your environment variables. In PowerShell you can reload your `PATH` environment variable using:
@ -147,19 +147,19 @@ You can clear the search index using npm:
npm run-script index:clear npm run-script index:clear
# (Optional) Rebuilding the Search Index # (Optional) Rebuild the Search Index
You can clear and rebuild the search index in one go using npm: You can clear and rebuild the search index in one go using npm:
npm run-script index:reindex npm run-script index:reindex
# Incrementally Building the Document Search Index # Incrementally Build the Document Search Index
You can scan all of the documents into the search index incrementally using npm. If the index is empty, all the documents will be scanned. If the file exists in the index, it's hash is checked before scanning the document's text. The presumption is that a second scan would produce the same text, and the scan is computationally expensive. Using npm, incrementally build the search index: You can scan all of the documents into the search index incrementally using npm. If the index is empty, all the documents will be scanned. If the file exists in the index, it's hash is checked before scanning the document's text. The presumption is that a second scan would produce the same text, and the scan is computationally expensive. Using npm, incrementally build the search index:
npm run-script index:docs npm run-script index:docs
# Incrementally Building the Laws Search Index # Incrementally Build the Laws Search Index
You can scan all of the laws into the search index incrementally using npm. If the index is empty, all the documents will be scanned. If the file exists in the index, it's hash is checked before scanning the document's text. The presumption is that a second scan would produce the same text, and the scan is computationally expensive. Using npm, incrementally build the search index: You can scan all of the laws into the search index incrementally using npm. If the index is empty, all the documents will be scanned. If the file exists in the index, it's hash is checked before scanning the document's text. The presumption is that a second scan would produce the same text, and the scan is computationally expensive. Using npm, incrementally build the search index: