Skip to content

Commit e72c406

Browse files
toastercupgitbook-bot
authored andcommitted
GitBook: [master] 6 pages modified
1 parent 0957cfa commit e72c406

File tree

6 files changed

+38
-8
lines changed

6 files changed

+38
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Cortex [CMS](glossary.md#cms) is a [multitenant](https://en.wikipedia.org/wiki/M
44

55
Cortex adheres to a headless, API-only architecture - it avoids a monolithic, all-in-one architecture associated with CMSs like WordPress or Drupal.
66

7-
To jump straight into using Cortex CMS, please refer to the [manual setup guide](basics/setup/manual-setup.md).
7+
To jump straight into using Cortex CMS, please refer to either the [Docker Compose guide](basics/setup/docker-compose.md) \(recommended\) or the [manual setup guide](basics/setup/manual-setup.md).
88

99
[![CircleCI](https://circleci.com/gh/cortex-cms/cortex.svg?style=svg)](https://circleci.com/gh/cortex-cms/cortex) ![Code Climate](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/gpa.svg) ![Test Coverage](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/coverage.svg)
1010

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Examples](examples.md)
88
* [Basics](basics/README.md)
99
* [Setup](basics/setup/README.md)
10+
* [Docker Compose](basics/setup/docker-compose.md)
1011
* [Manual Setup](basics/setup/manual-setup.md)
1112
* [Core & Plugin Development](basics/setup/core-and-plugin-development.md)
1213
* [Deployment](basics/deployment.md)

basics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Working with Cortex CMS as a [superadministrator](../glossary.md#superadministrator) may seem daunting at first blush, but we're here to walk you through every step and demonstrate the simplicity & power of the platform.
44

55
* [Setup](https://github.com/cortex-cms/cortex-cms/tree/ec0acc5e822e7cd071403cac968f82e8f6df4a96/basics/setup.md)
6+
* [Docker Compose](https://docs.cortexcms.org/basics/setup/docker-compose)
67
* [Manual](setup/manual-setup.md)
78
* [Core & Plugin Development](setup/core-and-plugin-development.md)
8-
* Docker Compose _\(coming soon\)_
99
* Engine Mounting _\(coming soon\)_
1010
* [Deployment](deployment.md)
1111
* [Tenancy & User Management](tenancy-and-user-management.md)

basics/setup/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,8 @@
22

33
If you're interested in local development with Cortex \(relevant to [integration engineers](../../glossary.md#integration-engineer), or those who wish to contribute to the project\), these guides will walk you through the process across any POSIX OS.
44

5+
* [Docker Compose](docker-compose.md)
56
* [Manual](manual-setup.md)
67
* [Core & Plugin Development](core-and-plugin-development.md)
7-
* Docker Compose _\(coming soon\)_
88
* Engine Mounting _\(coming soon\)_
99

10-
11-

basics/setup/docker-compose.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
description: >-
3+
Docker Compose automates the configuration, provisioning and execution of
4+
Cortex CMS on a single machine. Follow this guide to quickly get started with
5+
Cortex CMS.
6+
---
7+
8+
# Docker Compose
9+
10+
## Environment Preparation
11+
12+
Install `docker` and `docker-compose` using the [installer](https://docs.docker.com/compose/install/#install-compose) or via your Operating System's package manager \(`pacman`, for example\), then launch the service.
13+
14+
## `cortex-starter` Preparation {#cortex-starter-prep}
15+
16+
As `cortex` itself is only a Rails Engine, it needs to be mounted within a parent Rails applicaton. [cortex-starter](https://github.com/cortex-cms/cortex-starter) serves as a starting point for new users, with `cortex` and `cortex-plugins-core` already mounted and configured with several example `ContentTypes`/`Decorators`. Start by cloning the repository:
17+
18+
```bash
19+
$ git clone git@github.com:cortex-cms/cortex-starter.git && cd cortex-starter
20+
```
21+
22+
## Provision & Launch Server
23+
24+
Provision and launch Cortex Starter, PostgreSQL, Redis, ElasticSearch, Sidekiq and live Webpack rebuild via Docker Compose:
25+
26+
```bash
27+
$ docker-compose up
28+
```
29+
30+
Once complete, the admin interface will be accessible locally at `http://localhost:3000`. To access Cortex CMS as superadmin, login as `admin@cortexcms.org` with password `welcome1`.
31+

basics/setup/manual-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Manual Setup
22

3-
## `cortex-starter` Prep
3+
## `cortex-starter` Preparation
44

55
As `cortex` itself is only a Rails Engine, it needs to be mounted within a parent Rails applicaton. [cortex-starter](https://github.com/cortex-cms/cortex-starter) serves as a starting point for new users, with `cortex` and `cortex-plugins-core` already mounted and configured with several example `ContentTypes`/`Decorators`. Start by cloning the repository:
66

@@ -21,7 +21,7 @@ For a rudimentary setup, these variables should be configured:
2121

2222
### System
2323

24-
#### OS X
24+
#### macOS
2525

2626
* Install the Xcode Command Line tools:
2727

@@ -128,5 +128,5 @@ Start Cortex, Sidekiq and live Webpack rebuild via Foreman with the `dev-server`
128128
$ bin/dev-server
129129
```
130130

131-
The admin interface should now be accessible locally on port `3000`. To access Cortex as superadmin, login as `admin@cortexcms.org` with password `welcome1`.
131+
The admin interface should now be accessible locally at `http://localhost:3000`. To access Cortex as superadmin, login as `admin@cortexcms.org` with password `welcome1`.
132132

0 commit comments

Comments
 (0)