github pages toc
This commit is contained in:
parent
5c0d06586a
commit
16a61a3521
28
docs/Build.md
Normal file
28
docs/Build.md
Normal file
@ -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```
|
37
docs/README.md
Normal file
37
docs/README.md
Normal file
@ -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 <difrex.punk@gmail.com>
|
||||
* Denis Ryabyy <vv1r0x@gmail.com>
|
||||
|
||||
## LICENSE
|
||||
|
||||
Released under BSD 3-clause license. See [LICENSE](https://raw.githubusercontent.com/Difrex/surok/master/LICENSE)
|
Loading…
Reference in New Issue
Block a user