Skip to content

Installation

Dionisio edited this page Feb 10, 2025 · 7 revisions

Are you migrating from 1.x to 2.x?, please check this page before continuing with the installation.

Hardware requirements: while the stack in itself is not necessarily heavy, you will need sufficient resources to run all your projects and diskspace to store them. You'll need at least 8GB of RAM (16GB reccomended) and modern host (SSD, new processor) to run comfortably. We also assume common utilities are present:

  • git
  • curl
  • gunzip

Linux

Requirements

Docker

Follow the installation instructions for your distro from https://docs.docker.com/engine/install/. It is generally straightforward, except for users of Fedora 31 and above.

Shall I sudo docker or docker? Most setup instructions you will find online instruct you to add your user to the "docker" group to be able to call docker as a standard user. There is a non-neglectable risk with that approach, even though it is far more convenient than being prompted for your password each and every step.

By default, ce-dev will assume you went the "safe" way and use sudo docker or sudo docker-compose, but you can change that in your global configuration.

Docker Compose

Follow the installation instruction for your distro from https://docs.docker.com/compose/install/.

mkcert

Follow the instructions frow https://github.com/FiloSottile/mkcert#linux and make sure to have nss/certutil installed. On a successful install, running mkcert -install should output something along the lines of:

Using the local CA at "/home/XXX/.local/share/mkcert" ✨
The local CA is already installed in the system trust store! πŸ‘
The local CA is already installed in the Firefox and/or Chrome/Chromium trust store! πŸ‘

Make sure to restart your browsers after installing.

inotify watcher limit

To leverage the Unison file mounting (see Mounts as to why you'd want to use that on Linux at all in the first place), we need to change the default limits for inotify watchers. On most systems, you can check what the current value is with:

cat /proc/sys/fs/inotify/max_user_watches

and/or

sudo sysctl fs.inotify.max_user_watches

The default value is often 8192, which is far too low. You must change this to a more suitable number, usually 65536. The location of the inotify config is different on different systems, so you'll need to re-search it for your distribution.

The most common method you'll find by Googling usually is along the lines of:

echo fs.inotify.max_user_watches=65536 | sudo tee -a /etc/sysctl.conf
sudo sysctl -p # Or better yet, reboot.

Nowadays, though, this is slowly being deprecated, and should instead be set through sysctl directly:

sysctl -n -w fs.inotify.max_user_watches=65536
sudo sysctl -p # Or better yet, reboot.

Install

To install ce-dev itself, use this one-liner:

curl -sL https://raw.githubusercontent.com/codeenigma/ce-dev/2.x/install.sh | /bin/sh -s -- --platform "linux"

It will install the latest 2.x version

Mac

Requirements

Docker

Follow the installation instructions from https://docs.docker.com/engine/install/.

Docker Compose

Docker Compose is bundled with Docker Desktop already.

mkcert

Follow the instructions from https://github.com/FiloSottile/mkcert#macos and triple check nss/certutil installed. On a successful install, running mkcert install should output something along the lines of:

Using the local CA at "/Users/XXX/.local/share/mkcert" ✨
The local CA is already installed in the system trust store! πŸ‘
The local CA is already installed in the Firefox and/or Chrome/Chromium trust store! πŸ‘

Make sure to restart your browsers after installing.

Install

To install ce-dev itself, use this one-liner:

curl -sL https://raw.githubusercontent.com/codeenigma/ce-dev/2.x/install.sh | /bin/sh -s -- --platform "darwin"

It will install the latest 2.x version