Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 3.05 KB

README.md

File metadata and controls

91 lines (59 loc) · 3.05 KB
Raw

Orange in Docker

This is an unofficial Docker image for Orange distribution.

What is Orange?

API Gateway based on OpenResty.

How to use this image

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

Link Orange To A MySQL Container

  • Run a MySQL container
docker run --name orange-database -e MYSQL_ROOT_PASSWORD=your_root_pwd -p 3306:3306 mysql:5.7

This is not the only way to get a runing mysql instance.

  • Create orange user and grant privileges
CREATE DATABASE your_database_name;

CREATE USER 'your_database_user'@'%' IDENTIFIED BY 'your_database_password';

GRANT ALL PRIVILEGES ON your_database_name.* TO 'your_database_name'@'%';

Import the initial data from a database dump.

  • 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)

Relative Link's

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

Operation Your Orange

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

User Feedback

Issues

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

Contributing

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.