Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kuzzleio/setup-script

The script that helps you set Kuzzle up
https://github.com/kuzzleio/setup-script

Last synced: about 2 months ago
JSON representation

The script that helps you set Kuzzle up

Awesome Lists containing this project

README

        

# Docker-compose files to run the Kuzzle stack

**Supported OS**

![Debian Jessie](https://kuzzleio.github.io/setup-script/debian-jessie.svg) ![Fedora](https://kuzzleio.github.io/setup-script/fedora.svg) ![Ubuntu Artful](https://kuzzleio.github.io/setup-script/ubuntu-artful.svg) ![Mac OS](https://kuzzleio.github.io/setup-script/osx.svg)

The docker-compose files in the `docker-compose` dir will allow you to run Kuzzle with optional SSL support.

## The `setup.sh` installation helper

Use the `setup.sh` script to perform a requirements check on your system and automatically start Kuzzle.
The script will _not_ install any dependencies on your behalf, but will instead give you hints on how to do it.

To run it, you don't need to clone this repository, you can just type

```
$ bash -c "$(curl https://raw.githubusercontent.com/kuzzleio/setup-script/master/setup.sh)"
```

Or, you can clone this repository and run the script with options

```
$ ./setup.sh --no-run
```

only performs the system requirements checks and pulls a Kuzzle stack from Docker repositories, without running it.

After running the stack, the `setup.sh` script checks whether Kuzzle is up or not within the default delay of 30 seconds. If your system is slow, you can give additional delay by specifying the `CONNECT_TO_KUZZLE_MAX_RETRY` environment variable

```
$ CONNECT_TO_KUZZLE_MAX_RETRY=180 ./setup.sh
```

This will give Kuzzle a total delay of 180 seconds to start.