How to Install PiCockpit

This page will show you how to install PiCockpit.

You do this in two steps:

  1. Add an API Key
  2. Install the picockpit-client

You only need to do this once for the API key, and once per Pi for the picockpit-client – then you’re set and can immediately start using PiCockpit!

Adding the API Key

Please follow the instructions:

You can find more details in this video:

PiCockpit Short Help & Walkthrough 2019

Note: the video will be updated to the new UI soon, a lot has happened in PiCockpit v2.0! The installation process is still the same, though.

One API key can be used for several Raspberry Pis – there is no need to create a new API key every time you add a new Raspberry Pi.

32 Bit vs 64 Bit

Picockpit runs on both 32 Bit and 64 Bit operating systems. Our administrative apps which help you control and monitor your Pi work on both. The BME688 and CO2 Sensor apps on the other hand only work on 32-Bit operating systems.

If you want to use this functionality you currently aren’t able to use 64-Bit. Everything else works the same and no changes in the installation process are needed.

Add a new Raspberry Pi to PiCockpit (install picockpit-client)

Here’s the quick and convenient one-liner to install picockpit-client:

bash -c "$(curl -k -s https://picockpit.com/setup.sh)"

You only need to run this once. Press enter when asked whether you want to proceed with the package installation. Also have your API key handy, as the installer will ask you for it.

The installer will acknowledge a successful installation and connection with PiCockpit.com: “Finished with connect – your Pi is now connected to picockpit.com, if everything was OK”.

Refresh the My Raspberry Pis view in your browser, and you’ll be able to see the new Raspberry Pi.

You can add up to 5 Raspberry Pis free of charge to PiCockpit.com. If you require more, please get in touch with us for a quote.

Elaborate installation instructions

If you’re curious what the one-liner above does, and would like to run the installation manually, please have a look at these manual installation instructions.

picockpit-client needs to be installed only once, it will automatically start on every boot.

The API key is case sensitive. The dot matters as well!

That’s it

The picockpit-client will automatically start when your Raspberry Pi boots, and it will allow you to monitor and control your Raspberry Pi.

Please refer to the documentation for ideas of what you can do with PiCockpit.

FAQ

Removing PiCockpit

We also have a help page for you detailing how to remove PiCockpit.

Will picockpit-client install on Raspbian 9 (Stretch)?

Unfortunately, as of PiCockpit v2.0, picockpit-client is only compatible with Raspbian / Raspberry Pi OS 10 (Buster). The reason lies in Python. The picockpit-client requires a more recent version of Python. We will look into making picockpit-client compatible across more platforms / OS releases in the future.

Is picockpit-client compatible with Ubuntu?

Unfortunately Ubuntu is currently not supported (due to incompatibilities, again, with Python).