github
/
portainer
mirror of https://github.com/portainer/portainer
1
0
Fork 0
Code Issues Releases Wiki Activity
portainer/build/docker-extension
History
itsconquest d9d1d6bfaa
feat(extension): add a readme [EE-3085] (#6888) 
* feat(extension): add a readme [EE-3085]

* add prerequisites
 		2022-05-11 11:58:11 +12:00
..
Makefile
…
README.md feat(extension): add a readme [EE-3085] (#6888) 2022-05-11 11:58:11 +12:00
docker-compose.yml fix(extension): always restart the backend [EE-3093] (#6890) 2022-05-06 15:14:24 +12:00
metadata.json fix(extension): add missing labels [EE-3068] (#6879) 2022-05-06 14:19:26 +12:00
portainer.svg
…

README.md

Installing the Portainer extension

Prerequisites

Docker desktop with extension support

First you must install a version of docker desktop with extension support (4.8.0 or later)

Docker extension CLI plugin

Next you must install the CLI plugin to enable extension development. Please follow Docker’s official documentation as it will be the most up to date

Tip: make sure you have started Docker Desktop for the first time before installing the CLI extension to prevent errors.

Build from local changes

  1. Run yarn to install the project dependencies
  2. Run yarn dev:extension to install the extension
  3. Make your code changes
  4. Re-run yarn dev:extension to rebuild and re-install with your latest changes

Accessing the Portainer extension

Going to your Docker Desktop dashboard, you should see Portainer listed in the Extension menu on the left and can access Portainer directly by clicking it.

Improvements & suggestions

If you have an idea of how to improve this process or any of the code related to it, feel free to open an issue & pull request.