Automatic backup

iero · February 3, 2021, 12:21am

After reading the documentation, I understood that the proper way (today) to backup a ghost instance on a VPS is:

Export JSON file
copy the content directory

For the first one, there is two ways: using the administration interface and with ghost-cli (command line).

As I would like to do auto-backups, I would like to use the second one. But it’s interactive and so I cannot script this command:

iero@xxx:/opt/ghost$ ghost export ~/ghost_backup.json
+ sudo systemctl is-active ghost_ghost-iero-org
? **Enter your Ghost administrator email address** xxx@xxx.xx
? **Enter your Ghost administrator password** *[hidden]*
Exporting content

Is it possible to pass user/pwd in the command line ?
Or maybe bypass the autorisation for this simple ‘read’ action ?

If not possible, I will dump the database as usual. But it could be a good improvement for a future update.

vikaspotluri123 · February 3, 2021, 6:45am

The Ghost CLI is just a wrapper around the Ghost API which is why it needs your username and password:

task source

export logic:

github.com

TryGhost/Ghost-CLI/blob/68bb91937f559e7035d46c6d78c7727035f6c501/lib/tasks/import/api.js#L127-L136


async function downloadExport(version, url, auth, outputFile) {
    const authOpts = await getAuthOpts(version, url, auth);
    await new Promise((resolve, reject) => {
        const ws = fs.createWriteStream(outputFile);
        const resp = got.stream('/db/', {...authOpts}).pipe(ws);
        resp.on('finish', () => resolve()).on('error', reject);
    });
}

Kevin · February 3, 2021, 5:02pm

@iero I’m interested in what you found in the docs that indicated an export is a proper backup strategy. Can you provide a link?

An export is not a substitute for a backup, it’s designed to move content (posts, pages, members) etc from one instance of Ghost to another but it will not include certain settings or config for security reasons and also won’t include anything where the data can grow to be quite large such as your historic member and email stats.

For a proper backup you should follow standard practice for backing up files and database content, there shouldn’t be anything Ghost specific required.

iero · February 3, 2021, 4:42pm

Sorry @Kevin for the confusion, I thought an export/import was a convenient way to do a backup without dumping the database.

But ok, I’ll do that and a rsync of content directory!

Thanks for your reply!

iero · February 3, 2021, 10:36pm

By the way, this was the post (from Ghost staff) where I found that import/export was the good way to go:

Is this the right way to backup the DB?

#!/bin/bash

GHOST_DIR=/opt/ghost
GHOST_CONFIG=config.production.json

GHOST_BACKUP_DIR=~/

ghost_db=$(jq -r '.database.connection.database' ${GHOST_DIR}/${GHOST_CONFIG}) 
ghost_user=$(jq -r '.database.connection.user' ${GHOST_DIR}/${GHOST_CONFIG})
ghost_pwd=$(jq -r '.database.connection.password' ${GHOST_DIR}/${GHOST_CONFIG})

mysqldump --user=${ghost_user} --password=${ghost_pwd} --databases ${ghost_db} --single-transaction  --no-tablespaces | gzip > ${GHOST_BACKUP_DIR}/ghost_db_`date +%Y_%m_%d_%H%M`.sql.gz

jg3 · February 28, 2021, 9:04pm

Hi Kevin, I came here with the exact question as @iero … how to (safely) pass credentials to the ghost-cli export command.

I recognize this doesn’t include the [site]/content directory so it is technically incomplete … but with this and a one-line tar command, it is super easy to create a backup that can be re-implemented with another instance of Ghost, which is what I think I want.

Kevin · February 28, 2021, 10:30pm

An export is not a backup in the traditional sense. It’s intention is to be used for migrating content, it’s not a complete copy of your database so it won’t function as a restore point in the way a backup would. Importing will also modify ids and re-render contents so again, not what you would expect from a backup/restore.

If you’re looking for a backup I suggest you look at mysqldump or similar.