Quickstart

This guide will help you building and running TAO Community Edition from sources.

We will rely on a devcontainer to deploy the toolchain and isolate development activities.

Checklist

Hardware

• at least 20GB of space disk available
• at least 4 CPUs
• at least 8GB of RAM

System

OS support

This has been tested for recent Linux distrubution only. MacOS and Windows support and requirements may differ.

• docker daemon is installed and running, and your user can use it
• docker compose command is available
• sysctl records has the following value

  sysctl net.ipv4.ip_unprivileged_port_start=0
  

• ensure port 443 is currently free on your machine

Credentials

• ssh-agent is running with your GitHub key added

Gather sources

git clone -b develop git@github.com:tao-ce/tao-ce.git
cd tao-ce
git submodule update --init --recursive

Build from sources

1. Run VS Code (or any IDE compatible with devcontainers)
   • ensure to have Dev Containers extension installed
   • open this repository workspace
   • enter in Dev Container: Ctrl+Shift+P > Dev Container: Reopen in container
2. From Devcontainer terminal (Ctrl+Shift+`), run the following commands

   # initialize development enviornment services
   task dev:init
   # build all services from sources, and deploy them locally (similar to `docker compose up`)
   task dev:up
   

3. You can follow up deployement with loggy on http://localhost:18995 ; devcontainer should automatically forward it.
4. Once every service is built, its code is synced in /opt/tao-ce and the related systemd services are started.

Access TAO Community Edition

1. you may have to update your /etc/hosts file with 0.0.0.0 community.tao.internal
2. open https://community.tao.internal/portal
3. login with admin / password credentials

What's next

• You can now build and run TAO Community Edition locally!
• Check how to ship a container image
• You may find some interesting snippets to help you