https://github.com/s1syphos/docker-kirby-starter-kit
Getting started with Docker Compose & Kirby v3 in no-time
https://github.com/s1syphos/docker-kirby-starter-kit
Last synced: 11 months ago
JSON representation
Getting started with Docker Compose & Kirby v3 in no-time
- Host: GitHub
- URL: https://github.com/s1syphos/docker-kirby-starter-kit
- Owner: S1SYPHOS
- License: mit
- Created: 2019-03-17T07:40:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T20:05:30.000Z (about 7 years ago)
- Last Synced: 2025-02-17T01:26:10.665Z (over 1 year ago)
- Language: Dockerfile
- Homepage:
- Size: 6.84 KB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker/Kirby StarterKit
[](https://github.com/S1SYPHOS/Docker-Kirby-Starter-Kit/releases) [](https://github.com/S1SYPHOS/Docker-Kirby-Starter-Kit/blob/master/LICENSE) [](https://github.com/S1SYPHOS/Docker-Kirby-Starter-Kit/issues)
**You heard about Kirby CMS and want to use it on your next project? You want to harness the power of Docker? Then THIS is for you!**
Here's my personal (thus opinionated) Docker+Kirby boilerplate, starring:
- [Kirby CMS v3](https://getkirby.com) - a file‑based CMS that's 'easy to setup, easy to use & flexible as hell'
- [Docker Compose](https://docs.docker.com/compose/overview) - a tool for defining and running multi-container Docker applications
**Table of Contents**
- [1. Requirements](#requirements)
- [2. Getting started](#getting-started)
- [3. Configuration](#configuration)
- [4. Credits](#credits)
## Requirements
- Working [Docker environment](https://docs.docker.com/compose/gettingstarted)
- [Composer](https://getcomposer.org)
## Getting started
Download or clone this repository, then install the [Gulp/Kirby StarterKit](https://github.com/S1SYPHOS/Gulp-Kirby-Starter-Kit) (or any other Kirby project):
```text
# Composer
composer create-project s1syphos/gulp-kirby-starter-kit htdocs --no-dev --prefer-dist
# Git
git clone https://github.com/S1SYPHOS/Gulp-Kirby-Starter-Kit.git htdocs
# Move docker configuration files
mv docker htdocs/
```
Now just type `docker-compose up` and code away!
## Configuration
This boilerplate assumes that `index.php` is stored inside `htdocs`:
```text
htdocs/
├── assets
├── content
├── kirby
├── site
└── index.php
```
However, for a [more secure setup](https://getkirby.com/docs/guide/configuration#custom-folder-setup) (and some extra straightforwardness), the following structure is recommended:
```text
htdocs/
├── content
├── kirby
├── public
│ ├── assets
│ ├── .htaccess
│ └── index.php
├── site
└── storage
├── accounts
├── cache
└── sessions
```
The webserver only exposes the `public` directory, which contains `assets`, `index.php` and `.htaccess`. For this to work, simply move some files around, update your `index.php` (Gulp/Kirby StarterKit [got your back](https://github.com/S1SYPHOS/Gulp-Kirby-Starter-Kit/blob/master/index.php)) and `docker-compose.yml` (just comment/uncomment some lines).
## Credits
@rasteiner's [k3-dockercompose-starterkit](https://github.com/rasteiner/k3-dockercompose-starterkit) inspired this boilerplate - he deserves all the credit.
## Special Thanks
I'd like to thank everybody that's making great software - you people are awesome. Also I'm always thankful for feedback and bug reports :)