pixies

Here the setup for Linux is described. Pixies can be installed in several ways.

Installation with Docker

::: tip Help You don't know how to install Docker? Then check out this guide :::

::: code-group

docker run -d -p 5216:5216 -v pixies:/pixies/data --restart=unless-stopped --name Pixies ghcr.io/ikhsanddy/pixies

docker run -d -p 5216:5216 -v pixies:/pixies/data --restart=unless-stopped --name Pixies ghcr.io/ikhsanddy/pixies:development

:::

Automatic installation

::: code-group

curl -sSL https://raw.githubusercontent.com/ikhsanddy/pixies/master/scripts/install.sh | bash

curl -sSL https://raw.githubusercontent.com/ikhsanddy/pixies/development/scripts/install.sh | bash -s -- --beta

:::

Automatic uninstall process

Don't want to use Pixies anymore? You can easily remove Pixies. Decide here if you want to keep or delete your data.

::: warning Execute these commands with caution Executing the commands will result in deletion / uninstallation of Pixies. Please be aware of this. :::

::: code-group

curl -sSL https://raw.githubusercontent.com/ikhsanddy/pixies/development/scripts/uninstall.sh | bash -s -- --keep-data

curl -sSL https://raw.githubusercontent.com/ikhsanddy/pixies/development/scripts/uninstall.sh | bash

:::

Manual installation

sudo apt-get install wget curl -y #(1)

mkdir /opt/pixies && cd /opt/pixies #(2)

# Detect architecture and download the appropriate binary
ARCH=$(uname -m)
if [ "$ARCH" = "x86_64" ]; then
  ARCH="x64"
elif [ "$ARCH" = "aarch64" ]; then
  ARCH="arm64"
fi

wget $(curl -s https://api.github.com/repos/ikhsanddy/pixies/releases/latest \
  | grep "browser_download_url.*linux-${ARCH}" | cut -d '"' -f 4) \
  -O pixies #(3)

chmod +x pixies #(4)

./pixies #(5)

1. Here you install all necessary packages to install the project.
2. Now create the folder where you want to install Pixies. In this case it is the folder /opt/pixies.
3. Download the pre-compiled binary for your architecture (x64 or arm64).
4. Make the binary executable.
5. Now Pixies is started. Pixies is now available on port 5216. If you plan to run Pixies in the background, see the guide below.

Install Pixies from the source code

::: warning Attention This process installs the latest development version of Pixies. Errors may occur.

:::

sudo apt-get install git curl unzip -y #(1)

# Install Bun
curl -fsSL https://bun.sh/install | bash
export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH" #(2)

mkdir /opt/pixies && cd /opt/pixies #(3)

git clone https://github.com/ikhsanddy/pixies.git . #(4)

bun install #(5)

cd client && npm install && npm run build && cd .. && mv client/build . #(6)

bun run server/index.js #(7)

1. Here you install all necessary packages to install the project.
2. This step installs the Bun runtime.
3. Now create the folder where you want to install Pixies. In this case this is the folder /opt/pixies.
4. Clone the Pixies repository to get access to the code.
5. Now install all dependencies of the server.
6. Now compile the interface of Pixies and move it to the folder where Pixies can read it.
7. Now start Pixies. Pixies is now accessible on port 5216. If you plan to run Pixies in the background, see the guide below.

Install Pixies 24/7

::: warning Important You have used the installation script? Then you don't need to do this step at all. :::

Installing as a system service is not even that hard. In this case we use systemd, because it is directly integrated in most Linux distributions.

1. Create a file named pixies.service under /etc/systemd/system. Here we use nano

   nano /etc/systemd/system/pixies.service
   

2. Now paste the content of the file.

   [Unit]
   Description=Pixies
   After=network.target
   
   [Service]
   Type=simple
   ExecStart=/opt/pixies/pixies
   Restart=always
   # \/ It is strongly recommended to create your own user here
   User=root
   # \/ Specify your installation location here
   WorkingDirectory=/opt/pixies 
   
   [Install]
   WantedBy=multi-user.target
   

3. Save the file. This varies a bit depending on the editor

   ::: code-group

    Press `CTRL` + `X`, then press `Y` and press `Enter` to save the file and exit the editor.
   

   Press `ESC`, then type `:wq` and press `Enter` to save the file and exit the editor.
   

4. Now reload systemd

   systemctl daemon-reload
   

5. If you want Pixies to boot at systemd startup, type this command:

   systemctl enable pixies
   

6. Done! Now you can finally start Pixies.

   systemctl start pixies
   

7. Now check the status of Pixies

   systemctl status pixies