quick installation guide¶
This quick installation guide installs the prerequisites and uses the default core4 settings. The setup has been tested with Debian 9 (Stretch). For Ubuntu 18.04 there is a dedicated Ubuntu 18.04 quick install guide.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | # install prerequisites sudo -s apt-get update apt-get install python3-pip python3-venv python3-dev gcc make git dirmngr libffi-dev --yes # install MongoDB sudo -s apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4 echo "deb http://repo.mongodb.org/apt/debian "$(lsb_release -sc)"/mongodb-org/4.0 main" | tee /etc/apt/sources.list.d/mongodb.list apt-get update apt-get install mongodb-org --yes systemctl start mongod.service systemctl enable mongod.service # clone core4 git clone https://github.com/plan-net/core4.git # setup and enter Python virtual environment cd core4 python3 -m venv .venv source enter_env # install core4 with webapps python setup.py --fe # finish local setup with MongoDB and local.yaml python local_setup.py |
Test installation of the core4os backend by running the worker with:
coco --worker
Open up another terminal, enter Python virtual environment, list available jobs and enqueue the dummy job:
source enter_env
coco --job
coco --enqueue core4.queue.helper.job.example.DummyJob
Use the job id to review job details:
coco --detail <job_id>
Open up another terminal, enter Python virtual environment, and launch the core4 api container:
coco --app --filter core4.api.v1
Visit the app manager at http://0.0.0.0:5001 with username admin and
password admin.
What’s next:
- learn how to develop and maintain core4 and core4 projects with core4os
- read about R setup and usage
- read about how to run core4os regression tests
- read the prerequisite installation guide and learn how to config the details of core4
- continue with examples