0.1.6 • Published 7 years ago

ustcmirror v0.1.6

Weekly downloads
5
License
MIT
Repository
github
Last release
7 years ago

ustcmirror

Build Status

Introduction

Aims to provide effortless management of docker containers on USTC Mirrors

Dependencies

  • Node.js > 6
  • Docker
  • MongoDB
  • python (building dep)
  • make (building dep)
  • g++ (building dep)

Quickstart

npm i -g ustcmirror

Specify the ip address to be bound in either /etc/ustcmirror/config.json or ~/.ustcmirror/config.json:

$ cat ~/.ustcmirror/config.json
{
    "BIND_ADDRESS": "1.2.3.4",
    "LOGDIR_ROOT": "/home/knight/logs"
}

Start a mongo instance:

docker run --name mongo -p 127.0.0.1:27017:27017 -tid mongo:3.4

Run the daemon in debug mode:

NODE_ENV=dev ustcmirror daemon

Play with the CLI:

ustcmirror -h

API Documentation

Configuration

Global configuration: /etc/ustcmirror/config.(js|json)

User-specific configuration: ~/.ustcmirror/config.(js|json)

Server side

ParameterDescription
DB_USERDefaults to empty.
DB_PASSWDDefaults to empty.
DB_HOSTDefaults to 127.0.0.1.
DB_NAMEDefaults to mirror.
DB_PORTDefaults to 27017.
API_PORTDefaults to 9999.
DOCKERD_PORTDefaults to 2375.
DOCKERD_HOSTDefaults to 127.0.0.1.
DOCKERD_SOCKETDefaults to /var/run/docker.sock.
BIND_ADDRESSDefaults to empty.
CT_LABELDefaults to syncing.
CT_NAME_PREFIXDefaults to syncing.
LOGDIR_ROOTDefaults to /var/log/ustcmirror.
IMAGES_UPGRADE_INTERVALDefaults to 1 * * * *.
LOGLEVELDefaults to debug if NODE_ENV == 'dev' else warn.
OWNERDefaults to ${process.getuid()}:${process.getgid()}
TIMESTAMPDefaults to true

Client side

ParameterDescription
API_ROOTDefaults to http://localhost:${API_PORT}/.
0.1.6

7 years ago

0.1.5

7 years ago

0.1.4

7 years ago

0.1.3

7 years ago

0.1.2

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago