From 16a61a352137a4913292165a637d1d9cd9fb91cd Mon Sep 17 00:00:00 2001 From: Denis Zheleztsov Date: Thu, 12 Jan 2017 13:02:20 +0300 Subject: [PATCH] github pages toc --- docs/Build.md | 28 ++++++++++++++++++++++++++++ docs/README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 docs/Build.md create mode 100644 docs/README.md diff --git a/docs/Build.md b/docs/Build.md new file mode 100644 index 0000000..3809ff7 --- /dev/null +++ b/docs/Build.md @@ -0,0 +1,28 @@ +# Build packages and images + +build debian package +``` +cd build +./build.sh build_package +``` +A deb-package will be placed in build/out + +build surok base docker image(based on Ubuntu Xenial) +``` +cd build +./build.sh surok_image +``` + +build surok base Alpine image +``` +cd build +./build.sh alpine +``` + +build surok base CentOS image +``` +cd build +./build.sh centos +``` + +ENTRYPOINT is: ```cd /opt/surok && pytho3 surok.py -c /etc/surok/conf/surok.json``` diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3866938 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,37 @@ +# Surok + +[![Build Status](https://travis-ci.org/Difrex/surok.svg?branch=master)](https://travis-ci.org/Difrex/surok) + +Service discovery for Apache Mesos. + +* Jinja2 Templates +* Discovery over mesos-dns +* Applications config reload + +**Table of Contents** + +- [Surok](https://difrex.github.io/surok/) + - [Build](https://difrex.github.io/surok/Build.md) + - [Wiki](https://github.com/Difrex/surok/wiki) + - **Configuration** + - [Main config file](https://difrex.github.io/surok/Main-config-file.md) + - [App config file](https://difrex.github.io/surok/App-config-file.md) + - [Templates](https://difrex.github.io/surok/Templates.md) + - **Usage** + - [Use Surok with Supervisord](https://difrex.github.io/surok/Use-Surok-with-supervisord.md) +- [Known issues](#known-issues) +- [Athors](#authors) +- [LICENSE](#license) + +## Known issues + +* python3-memcache is broken in Debian Jessie. Backport fresh version from testing (>= 1.57). + +## Authors + +* Denis Zheleztsov +* Denis Ryabyy + +## LICENSE + +Released under BSD 3-clause license. See [LICENSE](https://raw.githubusercontent.com/Difrex/surok/master/LICENSE)