openrat-cms

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (3835B)

      1 # OpenRat Content Management System
      2 
      3 ![Screenshot](doc/images/screenshot-overall.png)
      4 
      5 
      6 ## About
      7 
      8 OpenRat is a statifying CMS, also known as a [static site generator](https://en.wikipedia.org/wiki/Web_template_system#Static_site_generators).
      9 
     10 OpenRat generates static files, which are served by a dedicated live web server like Apache, Nginx, Boa etc.
     11 
     12 Unlike other static site generators OpenRat CMS contains a complete Web UI with user management.
     13 
     14 ### Why OpenRat?
     15 
     16 Yes, there are a lot of good CMS in the world, and a lot of them are available for free. Why should you use OpenRat CMS?
     17 
     18 **OpenRat combines the world of static site generators with a complete web UI**. Editors do not have to use a version control system, they only use their browser.
     19 
     20 
     21 ## Install
     22 
     23 ### Requirements
     24 
     25 You need a server with PHP >= 5.6 and a relational database.
     26 
     27 MariaDB and MySQL are recommended, while PostgresQL and SQLite are supported too.
     28  
     29 
     30 ### Docker
     31 
     32 #### Docker-Compose
     33 
     34 The easiest way is to start the content-management-system inside a docker machine with an MySql database.
     35 Copy the following lines to a file named `docker-compose.yml`.
     36 
     37 ```
     38 version: '3.3'
     39 
     40 services:
     41   db:
     42     image: mysql:5.7
     43     volumes:
     44       - db_data:/var/lib/mysql
     45     restart: always
     46     environment:
     47       MYSQL_ROOT_PASSWORD: uoia97723sdsd9782
     48       MYSQL_DATABASE: cms
     49       MYSQL_USER: cms
     50       MYSQL_PASSWORD: dsfg77er35fsd08435
     51   cms:
     52     depends_on:
     53     - db
     54     image: openrat/openrat-cms:latest
     55     ports:
     56     - "8000:8080" # CMS
     57     - "8001:8081" # public
     58     - "8002:8082" # public with host routing
     59     restart: always
     60     environment:
     61       DB_TYPE: mysql
     62       DB_HOST: db
     63       DB_USER: cms
     64       DB_PASS: dsfg77er35fsd08435
     65       DB_NAME: cms
     66       CMS_MOTD:
     67       CMS_NAME: Content-Management
     68       CMS_OPERATOR: Your Company
     69   volumes:
     70     db_data: {}
     71 ```
     72 
     73 Start the environment with `docker-compose up -d`.
     74 
     75 Now the CMS is available on [localhost:8000](http://localhost:8000).
     76 The published website is available on [localhost:8001](http://localhost:8001)
     77 
     78 #### Start the single CMS docker container
     79 
     80 Download and run the docker image from [Dockerhub](https://hub.docker.com/r/openrat/openrat-cms), you need an already  running database.
     81 
     82 `docker run -d -p 8080:8080 -e DB_HOST=$host -e DB_NAME=$name -e DB_USER=$user -e DB_PASS=$pass openrat/openrat-cms`
     83 
     84 Be sure to replace the variables.
     85 
     86 #### Environment variables for Docker
     87 
     88 The following environment variables could be set in the docker container: 
     89 
     90 | Name         | Description          |   Default |
     91 |--------------|----------------------| ------- |
     92 | DB_TYPE      | database type        |mysql
     93 | DB_HOST      | database hostname    |localhost
     94 | DB_NAME      | database schema      |cms
     95 | DB_USER      | database user        |cms
     96 | DB_PASS      | database password    |\<empty\>
     97 | CMS_MOTD     | Message of the day   |Welcome to dockerized CMS
     98 | CMS_NAME     | Software name        |OpenRat CMS (Docker)
     99 | CMS_OPERATOR | Name of your company |Docker-Host
    100 | CMS_TIMEZONE | Timezone             |UTC
    101 | CMS_LANGUAGE | Language             |Browser
    102 
    103 
    104 ### Local installation
    105 
    106 The old style local installation is possible with the following steps.
    107 
    108 #### Download and untar it
    109 
    110 Download the [latest release](https://github.com/dankert/openrat-cms/releases) from Github and install it on your server.
    111 
    112 #### Clone GIT repository
    113 
    114 Or clone the GIT repository with the command
    115 
    116 `git clone http://git.code.weiherhei.de/openrat-cms.git`
    117 
    118 or from Github
    119 
    120 `git clone https://github.com/dankert/openrat-cms.git`
    121 
    122 #### Add database configuration
    123 
    124 Edit the file `config/config.yml` and enter your database access data, like:
    125 
    126     database:
    127       db:
    128         enabled : true
    129         dsn     : "mysql:host=localhost; dbname=name_of_db; charset=utf8"
    130         user    : "user"
    131         password: "password"
    132