README.md

Wraith

A simple utility Bash script to backup Ghost publishing platform. This script enables Ghost users to quickly and easily back up their entire platform, including the MySQL database.

Context

Getting started with Ghost is easy. You would pick between:

• Managed service
• Self-hosted on a VPS or serverless platform like Railway

Using managed version will most likely save you a bunch of headaches (and time) that come along with self-hosting any other sites:

• Backups
• Maintenance
• Downtime recovery
• Security, etc.

In short, you’d sleep easy at night while they stay awake.

Having that said, if you want to take on the challenge of self-hosting your own Ghost site, here's a tiny script to help with your backups.

Read more...

Table of Contents

• Wraith
  • Context
  • Table of Contents
  • Flowchart
  • Requirements
  • Usage
  • FAQ
  • Contributing
  • License

Flowchart

graph LR
  1(["start"]) --> 2["run checks"] --> 3["clean up"] --> 4["run `ghost backup`"] --> 5["run `mysqldump`"] --> 6["run `rclone` to sync backup to cloud storage"] --> 7["clean up"] --> 8(["end"])

Loading

Requirements

💡 Tip: run make check to check if all requirements are installed.

A list of CLI required to be installed:

• expect
• ghost
• gzip
• mysql
• rclone

Usage

💡 Tip: run make help to display help message.

Check out the Makefile

1. Access your Virtual Private Server (VPS) where your Ghost site is hosted
2. Utilize the sudo -i -u ghost-mgr command to switch to the ghost-mgr user, which is responsible for managing Ghost
3. Clone the repository onto the VPS
4. Run make setup and update the email and password field in wraith.exp
5. Optional: Run make backup to run backup manually

FAQ

See FAQ.md.

Contributing

See CONTRIBUTING.md.

License

See LICENSE.