Install from Docker within 5 mins

Per-requirements

• Mac or Linux (Windows not supported yet)

• Docker installed

• Docker-Compose installed

• Clone this 'docker' repo (make sure the scripts and docker compose file are available)

  git clone https://github.com/FlowCI/docker.git

Start Service

1. Start from command

## cd to docker dir which has been cloned
##
## example: cd ${HOME}/docker

./start-server.sh {host} {email} {password}

• {host}: The host domain or ip address, find it by ifconfig.

  Hint: It doesn't work for 127.0.0.1 or localhost

• {email} (Optional): Default admin email.

  admin@flow.ci will be default value if this argument not defined.

• {password} (Optional): Default admin password.

  123456 will be default value if this argument not dfined

Login with admin email and password on http://{host}:2015

Default Settings

• Port 8080: core service
• Port 2015: web
• Port 27017: database
• Port 2181: zookeeper
• Port 5672 & 15672: rabbitmq
• Port 9000: minio
• where to store the data: ${HOME}/.flow.ci

The default ports are exposed to host and data path can be changed from server.yml and start-server.sh

2. Example

## Start with host, define admin email and password
./start-server.sh 172.20.10.4 admin@flow.ci 1qaz@WSX

Start Agent

1. Create Agent from admin page

• Open web page: http://{host}:2015/#/settings/agents and click add
• Fill in agent name.
• Fill in agent tag and click '+' button to add.
• Click 'save' button

2. Start from command

• Click 'copy' button to copy the token

• Start from command: start-agent.sh {host} {token}

  • {host}: the host or ip address of server
  • {token}: the agent token copied from admin page
  • example:

  ./start-agent.sh 172.20.10.4 c2a957b7-5d09-4aa8-8d4f-90a0c2ee1392

Default Settings

• Port: the default port for ci server is 8080
• Where to store the data: default path is ${HOME}/.flow.ci.agent

those settings could be changed from start-agent.sh

3. Per-installed envrionments

• git: 2.17.1
• java: openjdk 1.8.0_222
• mvn: 3.5.4
• nvm: 0.34.0
• node: v10.16.3
• go: 1.12.9