...
For specific details, examine the contents of the setup script.
Requirements
- HardwareHardware
- RAM: 4GB
- CPU: x86_64 (*ARM support upon request)
- Free HD space: 20 GB
- GPU (*optional): Nvidia only (*AMD support to come)
- Software
- Ubuntu 18.04 or greater (or Debian-based equivalent)
- Nvidia driver 410.48 or greater
- CUDA toolkit 10.0 or greater
- Docker 20.10 or greater, plus nvidia-container-runtime (*will be installed by our system if not present)
...
The CE Datacenter/Enterprise environment can be set up by running the following commands:
| Code Block | ||
|---|---|---|
| ||
$ wget -O ce-docker-setup.ubuntu.sh https://www.charityengine.com/files/setup/ce-docker-setup.sh.ubuntu $ sh ce-docker-setup.ubuntu.sh |
The Usage of the ce-docker-setup.ubuntu.sh script supports the following may include a number of optional parameters:
| Code Block | ||
|---|---|---|
| ||
ce-docker-setup.ubuntu.sh [args] OPTIONS --auth |
...
// Specify the authenticator to use to connect the host to Charity Engine (if omitted, system will prompt for authenticator) |
...
--with-ipfs |
...
// Allow use of IPFS content on the host for task input files; this updates the ipfs config file to add a UNIX socket API interface so that files can be fetched |
...
--no-gpu |
...
// Do not set up GPU packages or run the client with GPU support |
...
--service-mode |
...
// Keep container running, fetching and processing new |
...
tasks [default] --task-mode |
...
// Run a single task, if available, then stop the container |
(To debug, see 2.2 To troubleshoot)
Once setup has been completed on a system, the CE client can be managed via Docker:
| Code Block | ||
|---|---|---|
| ||
$ docker [start|stop] ce-client |
...
When new features or other improvements have been made to the setup script or CE client container image, the environment can be upgraded by fetching and running the latest setup script:
| Code Block | ||
|---|---|---|
| ||
$ wget -O ce-docker-setup.ubuntu.sh https://www.charityengine.com/files/setup/ce-docker-setup.sh.ubuntu $ sh ce-docker-setup.ubuntu.sh |
The Usage of the ce-docker-setup.ubuntu.sh script supports the following may include a number of optional parameters:
| Code Block | ||
|---|---|---|
| ||
ce-docker-setup.ubuntu.sh [args] OPTIONS --auth |
...
// Specify the authenticator to use to connect the host to Charity Engine (if omitted, system will prompt for authenticator) |
...
--with-ipfs |
...
// Allow use of IPFS content on the host for task input files; this updates the ipfs config file to add a UNIX socket API interface so that files can be fetched |
...
--no-gpu |
...
// Do not set up GPU packages or run the client with GPU support |
...
--service-mode |
...
// Keep container running, fetching and processing new |
...
tasks [default] --task-mode |
...
// Run a single task, if available, then stop the container |
(To debug, see 2.2 To troubleshoot)
The CE client configuration will remain in the ~/.ce directory, so any work that was in progress prior to the upgrade will be continued.
...
To remove all CE files and containers from the system:
| Code Block | ||
|---|---|---|
| ||
$ rm -r ~/.ce ce-docker-setup.ubuntu.sh nginx_work_proxy.conf $ docker rm -f ce-client work-proxy |
...
Launch the container:
| Code Block | ||
|---|---|---|
| ||
$ docker start ce-client |
Once the ce-client container is started,
...
For details on what is happening, and especially to identify any errors, run:
| Code Block | ||
|---|---|---|
| ||
$ docker logs ce-client |
To capture output from the setup script, append " 2>&1 | tee debug.out ", which will write setup script activity to a file, debug.out
| Code Block | ||
|---|---|---|
| ||
$ sh ce-docker-setup.ubuntu.sh –service-mode 2>&1 | tee debug.out |
...