https://github.com/ngshiheng/wraith

A simple utility Bash script to backup Ghost publishing platform
https://github.com/ngshiheng/wraith

backup bash ghost shell

Last synced: 2 months ago
JSON representation

A simple utility Bash script to backup Ghost publishing platform

• Host: GitHub
• URL: https://github.com/ngshiheng/wraith
• Owner: ngshiheng
• License: apache-2.0
• Created: 2022-07-21T13:03:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-26T03:38:01.000Z (8 months ago)
• Last Synced: 2024-11-09T09:43:57.450Z (3 months ago)
• Topics: backup, bash, ghost, shell
• Language: Shell
• Homepage:
• Size: 384 KB
• Stars: 38
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wraith

[![shellcheck](https://github.com/ngshiheng/wraith/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/ngshiheng/wraith/actions/workflows/shellcheck.yml)

A simple utility Bash script to backup [Ghost](https://github.com/TryGhost/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](https://ghost.org/pricing/) service

-   Self-hosted on a [VPS](https://marketplace.digitalocean.com/apps/ghost) or serverless platform like [Railway](https://blog.railway.app/p/ghost)

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...](https://jerrynsh.com/backing-up-ghost-blog-in-5-steps/)

## Table of Contents

- [Wraith](#wraith)

  - [Context](#context)

  - [Table of Contents](#table-of-contents)

  - [Flowchart](#flowchart)

  - [Requirements](#requirements)

  - [Usage](#usage)

  - [FAQ](#faq)

  - [Contributing](#contributing)

  - [License](#license)

## Flowchart

```mermaid

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"])

```

## Requirements

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

A list of CLI required to be installed:

-   [`expect`](https://manpages.ubuntu.com/manpages/impish/man1/expect.1.html)

-   [`ghost`](https://ghost.org/docs/ghost-cli/)

-   [`gzip`](https://www.gnu.org/software/gzip/)

-   [`mysql`](https://www.mysql.com/)

-   [`rclone`](https://rclone.org/install/)

## Usage

> 💡 Tip: run `make help` to display help message.

>

> Check out the [Makefile](./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](docs/FAQ.md).

## Contributing

See [CONTRIBUTING.md](docs/CONTRIBUTING.md).

## License

See [LICENSE](LICENSE).