standardebooks/web
1
0
Fork 0
mirror of https://github.com/standardebooks/web.git synced 2025-07-05 14:20:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
web/scripts
History
Alex Cabal 99f49d7f51 Style tweaks
2024-11-26 11:12:19 -06:00
..
cavif Update cavif binary to one linked to Ubuntu 18.04 libs 2022-09-19 10:39:20 -05:00
cavif-LICENSE Add cavif LICENSE file as required 2022-09-18 22:08:19 +02:00
delete-unconfirmed-newsletter-subscribers Add Db::QueryBool() and some code style updates 2024-09-15 13:50:13 -05:00
deploy-ebook-to-www Uncomment call to chapter navigation footer script 2024-11-14 17:33:21 -06:00
generate-bulk-downloads Make MARC roles an enum and restructure how contributors are fetched from the DB to reduce queries 2024-11-11 12:01:53 -06:00
generate-feeds Refactor feed functions out of Library and add some enums 2024-11-15 21:13:35 -06:00
ingest-fa-payments Move enums into their own namespace 2024-11-08 16:34:21 -06:00
inject-chapter-navigation-footer Make chapter navigation footer script executable 2023-12-23 10:50:18 -06:00
pending-payments-watchdog Add Db::QueryBool() and some code style updates 2024-09-15 13:50:13 -05:00
process-pending-payments Add PropertyFromHttp trait and update codebase to use new pattern 2024-11-10 22:23:43 -06:00
README.md Normalize contents of webroot variables 2022-07-09 20:09:39 -05:00
rebuild-cache Expand some scripted command arguments 2024-11-25 14:08:14 -06:00
reset-php-fpm-opcache Style tweaks 2024-11-26 11:12:19 -06:00
rotate-www-logs Anonymize web logs after rotating and disable explicit download logging in favor of grepping the regular web logs 2022-03-16 13:04:52 -04:00
sync-ebooks When creating bare repos, clone with --mirror instead of --bare 2024-05-30 22:34:23 -05:00
update-ebook-database Rename flag to --ebook-www-filesystem-path 2024-11-04 13:16:56 -06:00
update-patrons-circle Use a NOW constant instead of new DateTimeImmutable objects, and tweak how some donation drive dates work 2024-10-15 22:21:12 -05:00

README.md

sync-ebooks

To use, call this script with the directory where your ebooks go as its last argument. For example sync-ebooks /standardebooks.org/ebooks, or if you want to clone them into this repository, sync-ebooks ebooks. If you want progress output, use -v, and if you want detailed Git progress output use -vv. GitHub allows you to make 60 unauthenticated API requests per hour. If you use unauthenticated API requests for other things, this might not be enough, so to resolve that issue, you can create a new OAuth token at https://github.com/settings/tokens/new and pass it via the --token option. You don’t need to give the token any permissions.

deploy-ebook-to-www

To use, call this script with the directories of the books you want to deploy as its arguments. For example, to deploy all ebooks after using sync-ebooks, run deploy-ebook-to-www /standardebooks.org/ebooks/*. To deploy only The Time Machine by H. G. Wells, you would run deploy-ebook-to-www /standardebooks.org/ebooks/h-g-wells_the-time-machine. To output progress information, use -v or --verbose.

The default web root is /standardebooks.org/web/www. If it is located elsewhere, specify it with the --webroot option. For instance, deploy-ebook-to-www --webroot /var/www/html /path/to/ebook. Note that there will be php errors if the Git repositories are not in the ebook directory immediately in the web root. Either keep them there or create a symlink.

The default group is se. to use a different one, specify it with the --group option.

The default URL is https://standardebooks.org. To change it, use the --weburl option. For example, deploy-ebook-to-www --weburl "http://localhost:8080". This option will cause deploy-ebook-to-www to use the specified URL in the generated OPDS and RSS files. Care should be taken however; the URL https://standardebooks.org is hard-coded in a few places, even when SITE_URL is changed to a custom URL, so for testing, it may be more convenient to simply use /etc/hosts or a similar mechanism to resolve standardebooks.org to 127.0.0.1.