English · 简体中文
Leverages GitHub Actions to schedule Calibre to send news via email.
Upload Recipe | Add Built-in Recipe | Update Schedule | Workflow | Environments | Enable/Disable | Destroy
- Create a project using the [use this template] button located in the top right corner.
- Navigate to [ Settings > Environments ] in your project.
- Click "New environment" to create a new environment named
calibre-news. - Add the required "environment secrets" to the environment as follows.
| Name | Required | Description | Example |
|---|---|---|---|
| FROM | Yes | Your email address | [email protected] |
| TO | Yes | Destination email address | [email protected] |
| ENCRYPT | Yes | SMTP encryption method | SSL |
| SECRET | Yes | SMTP password | xxxxxxxxxx |
| SMTP | Yes | SMTP server | smtp.gmail.com |
| PORT | Yes | SMTP port | 465 |
| FORMAT | No | The ebook format (default is epub) | epub |
| SIZE | No | Attachment size limit (default is 25MB) | 25 |
| DAYS | No | Ebooks retention period (default is 90 days) | 90 |
- Navigate to "Actions" and click [ Calibre News Delivery > Run workflow ] to test.
Normally, you may receive two example ebooks sent from your project.
Tip
📹 A Brief Tour Video: https://youtu.be/sIFsoztF58A
The default delivery is scheduled to occur daily at midnight (00:00) UTC. You can change it according to your preference. The cron expression - cron: '0 0 * * *' can be found in the workflow file located at:
/.github/workflows/calibre-news.yml
Please refer to the "schedule" documentation to specify an appropriate time. For example, if you are in a timezone that is UTC+8 and want the delivery to start at 6:00 AM every day, you can set the cron expression as 0 22 * * *, calculated using the formula UTC Time = Local Time − Offset.
Additionally, you can manually trigger the delivery on the "Actions" page of your project.
For the built-in recipes, you need to add their titles (found in the Title attribute of the recipe file) to the plain text file recipe_list.txt, one title per line. For manually written recipes, simply place them in the root of the project.
You can specify the cover and style for a recipe. Place the cover image in the "covers" folder and the style file in the "styles" folder. Both filenames must match the corresponding recipe title or filename. Be aware that the style may be ignored by the Send to Kindle service.
You can upload the recipe files using either the Git tool or GitHub's online uploading feature. The best practice is to test the recipe locally to ensure no errors occur before uploading it.
All converted ebooks will be zipped together and stored in the Artifacts of GitHub Actions. You can find and download them in the job details of each workflow record. Each file will be retained for up to 90 days from the date it is generated.
You can change the retention period in the "Artifact and log retention" section on the Actions settings page. You can also do this through the environment settings (refer to the Setup section).
Be aware that files exceeding the size limit for email attachments will not be sent via SMTP. You will need to download them manually from the Artifacts.
This project does not accept any PRs for adding recipes. Please do something interesting on your own.