Cookies ahead

Our support chat tool "Intercom" would like to collect some more data on you. See the related link for more details.

Docs

Grav install guide

Reviewedbyfl

Markdown ↓

Grav is a popular, free, file based CMS based on Twig & Markdown. Learn here how to install and tune Grav on fortrabbit.

Quick start

We usually advise running your project locally and using Git deployment. Since Grav CMS is a file-based content management system where files may change on the environment, we cannot advise using Git deployment, since it is designed to work as a one-way street.

SFTP installation guide

  1. Download the "latest Grav Core + Admin plugin" from the Grav website and unpack it locally.
  2. Copy all contents of the local grav-admin folder (not the folder itself) via SFTP to the htdocs folder of your environment.

Once upload is done, commence with the guided web installation to finish the setup.

Consider to use rsync to sync changes up and down.

Environment configuration

Grav allows you to configure different settings based on the domain it is served from. For example, if you are developing your Grav site locally, you probably want debugging enabled while you want it disabled when serving from fortrabbit. To that end, you can create domain-specific configurations. All you need to do is create a new system.yaml configuration file for your custom domain. Say the domain you are using is www.my-grav.tld, you would create the file user/www.my-grav.tld/config/system.yaml, in which you then set:

debugger:
  enabled: false
yaml

An even better approach is set your user/config/system.yaml as restrictive as possible while using a special localhost configuration in user/localhost/config/system.yaml, which enables debugging and so on:

debugger:
  enabled: true
yaml

Written by a human. Review, grammar checks and typo fixes by AI.

AI use & editorial processEdit on GitHub ↗