Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rija/ghost-ssg
A Docker-based pipeline to publish the content of a local Ghost 4 server as static pages.
https://github.com/rija/ghost-ssg
bash blogging cli docker docker-compose ghost ghost-cms gitlab integration jamstack nginx nodejs publishing scraping-tool self-hosted static-site-generator web-scraper wget workflow
Last synced: 9 days ago
JSON representation
A Docker-based pipeline to publish the content of a local Ghost 4 server as static pages.
- Host: GitHub
- URL: https://github.com/rija/ghost-ssg
- Owner: rija
- License: mit
- Created: 2023-01-22T15:11:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-02T16:49:44.000Z (over 1 year ago)
- Last Synced: 2024-10-17T08:50:23.422Z (19 days ago)
- Topics: bash, blogging, cli, docker, docker-compose, ghost, ghost-cms, gitlab, integration, jamstack, nginx, nodejs, publishing, scraping-tool, self-hosted, static-site-generator, web-scraper, wget, workflow
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Ghost-ssg [](https://gitlab.com/gh-rija/ghost-ssg/-/pipelines) [](https://matrix.to/#/#ghost-ssg:gitter.im)
A Docker-based pipeline to publish the content of a local Ghost 4 server as static pages.
## How it works
```
┌──────────────────────────────┐ ┌──────────────────────────────┐ ┌──────────────────────────────┐ ┌──────────────────────────────┐
│ │ │ │ │ │ │ │
│ │ │ │ │ │ │ │
│ │ export │ │ preview │ │ git push │ │
│ Post editing and management ├────────────────────► Static pages on file system ├────────────────────────►Site served on local web server──────────────────►Site served on GitLab Pages │
│ │ │ │ │ │ │ │
│ │ │ │ │ │ │ │
└──────────────────────────────┘ └──────────────────────────────┘ └──────────────────────────────┘ └──────────────────────────────┘
```
## Prerequisites
1. You need to have installed on your system already:
* Docker
* bash
* git
* bats-core (optional, for running the test suite)
2. To publish to remote destination, you need to have a git-enabled remote static page hosting setup and configured:
| Host type | Needs done before | More infos |
| -- | -- | -- |
| Bitbucket | have created a new repository on Bitbucket.org| https://support.atlassian.com/bitbucket-cloud/docs/publishing-a-website-on-bitbucket-cloud/ |
| Codeberg | have created a new public repo named "pages" on Codeberg.org | https://docs.codeberg.org/codeberg-pages/ |
| GitHub | have followed instructions in the docs on Github.com | https://docs.github.com/en/pages/quickstart |
| GitLab | have created a new project of type "Pages/Plain HTML" on GitLab.com | https://docs.gitlab.com/ee/user/project/pages/ |
>**Disclaimer:** at time of writing, I have only tested with GitLab.com (it may work on other GitLab-based forges - like framagit.org - , not sure for the other ones)
## Usage
1. Run the setup script:
```
$ ./setup
```
Then edit .env file to assign a value to ``DEST_REPO``, ensure the value for PAGES_REPO_PATH and DEST_BRANCH are correct
2. Start the servers (the blog editor, the preview server and the backup server)
```
$ ./up
```
Ghost is now available at http://localhost:2368
3. Export the content of Ghost as static file for preview
```
$ ./preview
```
A preview of the static website can be viewed at http://localhost:9999
4. Publish the content of Ghost
```
$ ./publish
```
The static web pages are first exported in the ``public`` directory inside the directory defined by the $PAGES_REPO_PATH variable.
Then the changes are commited and pushed to the remote git repository.
7. Backup your installation
```
$ ./backup
```
This will backup the SQL database and the content directory
6. Shutdown the servers
```
$ ./down
```
## Troubleshooting
* Show what server is up:
```
$ ./whatsup
```
* Inspect the server logs:
```
$ ./log
```
* Show the current versions of the dependencies
```
$ ./versions
```
* Run the test suite
```
$ ./test
```
* Restore from backup
```
$ ./restore
```