README.md (2332B)
1 # OpenRat Content Management System 2 3  4 5 6 ## About 7 8 OpenRat is a statifying CMS. 9 10 OpenRat generates static files, which are served by a dedicated live web server like Apache, Nginx, Boa etc. 11 12 Unlike popular static site generators like Jekyll, JBake etc. 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.5 and a relational database. 26 27 MariaDB and MySQL are recommended, while PostgresQL and SQLite are supported too. 28 29 30 ### Local installation 31 32 #### Download and untar it 33 34 Download the last release from Github and install it on your server: 35 36 https://github.com/dankert/openrat-cms/releases 37 38 #### Clone GIT repository 39 40 Or clone the GIT repository with the command 41 42 `git clone http://git.code.weiherhei.de/openrat-cms.git` 43 44 or from Github 45 46 `git clone https://github.com/dankert/openrat-cms.git` 47 48 #### Add database configuration 49 50 Edit the file `config/config.yml` and enter your database access data, like: 51 52 database: 53 db: 54 enabled : true 55 dsn : "mysql:host=localhost; dbname=name_of_db; charset=utf8" 56 user : "user" 57 password: "password" 58 59 ### Docker 60 61 OpenRat-CMS is available [at Dockerhub](https://hub.docker.com/r/openrat/openrat-cms). 62 63 #### Run the docker container 64 65 Download and run the docker image from dockerhub: 66 67 `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` 68 69 Be sure to replace the variables. 70 71 #### Environment variables for Docker 72 73 The following environment variables could be set in the docker container: 74 75 | Name | Description | Default | 76 | ----------- | ----------- | ------- | 77 |DB_TYPE|database type|mysql 78 |DB_HOST|database hostname|localhost 79 |DB_NAME|database schema|cms 80 |DB_USER|database user| 81 |DB_PASS|database password| 82 |CMS_MOTD|Message of the day|Welcome to dockerized CMS 83 |CMS_NAME|Software name|OpenRat CMS (Docker) 84 |CMS_OPERATOR|Name of your company|Docker-Host 85