https://github.com/charles-m-knox/ghost-to-castopod

Synchronizes Ghost paid subscribers with Castopod.
https://github.com/charles-m-knox/ghost-to-castopod

castopod ghost go golang subscribers synchronizer

Last synced: 29 days ago
JSON representation

Synchronizes Ghost paid subscribers with Castopod.

• Host: GitHub
• URL: https://github.com/charles-m-knox/ghost-to-castopod
• Owner: charles-m-knox
• License: agpl-3.0
• Created: 2024-09-09T02:50:27.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-09T03:01:48.000Z (4 months ago)
• Last Synced: 2024-11-21T05:36:18.782Z (about 1 month ago)
• Topics: castopod, ghost, go, golang, subscribers, synchronizer
• Language: Go
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ghost-to-castopod

Takes Ghost blog subscriptions and pushes them to a Castopod server.

This leverages a database connection - Ghost recommends mysql as its supported database type, but it can technically work with any compliant driver that implements Go's `database/sql` interfaces.

This is compatible with **Ghost v5.87.1** and **Castopod v1.12.3**. Compatibility with any other version is not guaranteed.

## Example Usage

See [`examples/simple/README.md`](./examples/simple/README.md).

## Warnings and limitations

First and foremost, you must manage the Redis cache separately from this application. Castopod stores data in Redis (if available) and updates to the database will not be reflected. One easy way to manage this is to purge the Redis cache whenever this application runs:

```bash

export REDIS_PASSWORD=your_password_goes_here

redis-cli FLUSHALL

```

If you're running it in a container, do the following *immediately* after using this library:

```bash

podman exec -it castopod-redis redis-cli -a your_password_goes_here FLUSHALL

```

Additionally, **Please verify the output of this application before using it**. Stability is never guaranteed. Make backups.

## Structure

In order to keep dependencies to zero (see [`go.mod`](./go.mod) - it only uses the standard library), this Go module is structured as a library that can be imported by any application.

This has the benefit of not requiring any specific SQL driver - it accepts SQL rows themselves from the `database/sql` package. You can use any compliant driver, such as sqlite or postgres - although I haven't tried anything aside from mysql, so tread carefully.

## Development notes

The `ghosttocastopod` package is the primary library for this module. Its unit test coverage is currently at **`82.5%`** and at this time, I do not intend to get it higher. The core business logic is well-tested; everything else remaining is not worth unit testing.

## Compatibility

Here is a list of all tested Ghost versions that are known to work:

- v5.87.1

Here is a list of all tested Castopod versions that are known to work:

- v1.12.3

If any database migrations that modify the tables used by this library occur upstream, this application will likely break.