This is an unofficial Docker image for Orange distribution.

API Gateway based on OpenResty.

First, orange requires a running mysql cluster before it starts. You can either use the official MySQL containers, or use your own.

• start a Orange container + its dependencies (mysql)

$ docker-compose run --service-ports --rm orange
# or
$ make run

Run in debug mode (bash) :

$ make debug-run

1. docker-compose up Bootstrap a brand new alert service container. if a old container exists, docker compose would reuse it in case of losing data.
2. docker-compose down Destroy all the containers defined in this compose file.
3. docker-compose start Start the existed containers.
4. docker-compose stop Stop the existed containers.
5. docker-compose restart Restart the existed containers, the new configuration would be applied immediately.
6. docker-compose run -d --service-ports --rm orange Almost the same with docker-compose up.

• Run a MySQL container

docker run --name orange-database -e MYSQL_ROOT_PASSWORD=your_root_pwd -e MYSQL_DATABASE=orange -p 3306:3306 mysql:5.7

This is not only way to get a runing mysql for orange, but for some dns issue, running a docker-mysql could simplify the process of running a orange instance.

• Runing a orange instance and initialize database scheme.

Modify the {block} content, and execute it.

ORANGE_INIT_DB variable would be deployment friendly on production.

docker run -d --name orange \
    --link orange-database:orange-database \
    -p 7777:7777 \
    -p 8888:80 \
    -p 9999:9999 \
    --security-opt seccomp:unconfined \
    -e ORANGE_DATABASE={your_database_name} \
    -e ORANGE_HOST=orange-database \
    -e ORANGE_PORT={your_database_port} \
    -e ORANGE_USER={your_database_user} \
    -e ORANGE_PWD={your_database_password} \
    syhily/orange

Access orange dashboard (Default Username: admin, Default Password: orange_admin)

1. Orange Dashboard
2. Orange API Endpoint
3. Orange Gateway Access Endpoint

docker exec -it orange orange COMMAND [OPTIONS]

The commands are:

start   Start the Orange Gateway
stop    Stop current Orange
reload  Reload the config of Orange
restart Restart Orange
version Show the version of Orange
help    Show help tips

If you have any problems with or questions about this image, please contact us through a GitHub issue.

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.