commit bb9b30c3a266146259b340242bced5bc034cf41b
parent 61ccbbb638008ca9a8562b6bffa58e1899589bb8
Author: Jan Dankert <devnull@localhost>
Date: Fri, 5 Apr 2019 23:53:30 +0200
README ergänzt, damit bei Github/Bitbucket gleich eine Beschreibung angezeigt wird.
Diffstat:
2 files changed, 54 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# OpenRat Content Management System
+
+
+
+
+## About
+
+OpenRat is a statifying CMS.
+
+OpenRat generates static files, which are served by a dedicated live web server like Apache, Nginx, Boa etc.
+
+Unlike popular static site generators like Jekyll, JBake etc. OpenRat CMS contains a complete Web UI with user management.
+
+### Why OpenRat?
+
+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?
+
+**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.
+
+
+## Install
+
+### What do I need?
+
+You need a server with PHP >= 5.5 and a relational database.
+
+MariaDB and MySQL are recommended, while PostgresQL and SQLite are supported too.
+
+
+#### Download and untar it
+
+Download the complete archive and install it on your server
+
+#### The GIT way
+
+`git pull`
+
+#### Docker
+
+OpenRat contains a Dockerfile. At the moment, you have to bake your own Docker Image.
+
+## Configuration
+
+Edit the file config/config.yml and enter your database access data, like:
+
+ database:
+ db:
+ enabled : true
+ dsn : "mysql:host=localhost; dbname=name_of_db; charset=utf8"
+ user : "user"
+ password: "password"
+
+That's it.+
\ No newline at end of file
diff --git a/screenshot-overall.png b/screenshot-overall.png
Binary files differ.
