Skip to content

Latest commit

 

History

History
103 lines (76 loc) · 2.34 KB

install.md

File metadata and controls

103 lines (76 loc) · 2.34 KB
Raw

Installing Codapi

Make sure you install Codapi on a separate machine — this is a must for security reasons. Do not store any sensitive data or credentials on this machine. This way, even if someone runs malicious code that somehow escapes the isolated environment, they won't have access to your other machines and data.

Steps for Debian (11+) or Ubuntu (20.04+).

  1. Install necessary packages (as root):
apt update && apt install -y ca-certificates curl docker.io make unzip
systemctl enable docker.service
systemctl restart docker.service
  1. Create Codapi user (as root):
useradd --groups docker --shell /usr/bin/bash --create-home --home /opt/codapi codapi
  1. Verify that Docker is working (as codapi):
docker run hello-world
  1. Install Codapi (as codapi):
cd /opt/codapi
curl -L -O "https://github.com/nalgeon/codapi/releases/download/0.9.0/codapi_0.9.0_linux_amd64.tar.gz"
tar xvzf codapi_0.9.0_linux_amd64.tar.gz
chmod +x codapi
rm -f codapi_0.9.0_linux_amd64.tar.gz
  1. Build Docker images (as codapi):
cd /opt/codapi
docker build --file images/alpine/Dockerfile --tag codapi/alpine:latest images/alpine/
  1. Verify that Codapi starts without errors (as codapi):
cd /opt/codapi
./codapi

Should print the alpine box and the sh command:

2023/09/16 15:18:05 codapi 20230915:691d224
2023/09/16 15:18:05 listening on port 1313...
2023/09/16 15:18:05 workers: 8
2023/09/16 15:18:05 boxes: [alpine]
2023/09/16 15:18:05 commands: [sh]

Stop it with Ctrl+C.

  1. Configure Codapi as systemd service (as root):
mv /opt/codapi/codapi.service /etc/systemd/system/
chown root:root /etc/systemd/system/codapi.service
systemctl enable codapi.service
systemctl start codapi.service

Verify that the Codapi service is running:

systemctl status codapi.service

Should print active (running):

codapi.service - Code playgrounds
    Loaded: loaded (/etc/systemd/system/codapi.service; enabled; preset: enabled)
    Active: active (running)
...
  1. Verify that Codapi is working:
curl -H "content-type: application/json" -d '{ "sandbox": "sh", "command": "run", "files": {"": "echo hello" }}' http://localhost:1313/v1/exec

Should print ok = true:

{
    "id": "sh_run_dd27ed27",
    "ok": true,
    "duration": 650,
    "stdout": "hello\n",
    "stderr": ""
}