Portainer Documentation
Official Website
Get 5 Nodes of BE Free
Search…
CE 2.11
Welcome
Release Notes
Getting Started
Introduction
Portainer architecture
Requirements and prerequisites
Install Portainer CE
Upgrading Portainer
Using Portainer
Home
Docker/Swarm
Kubernetes
Azure ACI
Edge Compute
Account settings
Administering Portainer
Users
Environments
Registries
Authentication logs
Settings
Frequently Asked Questions
Portainer Concepts
Installing
Upgrading
Troubleshooting
Contributing
Advanced Topics
CLI configuration options
App templates
The Portainer Edge Agent
Access control
Reset the admin user's password
Security and compliance
Using your own SSL certificate with Portainer
Using Portainer with reverse proxies
Helm chart configuration options
Deprecated and removed features
API
Accessing the Portainer API
API documentation
API usage examples
Get More Help
YouTube
Slack
Discord
Contribute to Portainer
Contribute
Build instructions
Set up a macOS build environment
Set up a Linux build environment
Powered By
GitBook
Build instructions
This article explains how to set up your local development environment so you can contribute to the Portainer codebase.
Make sure you have installed the dependencies for this project on your
Mac
or
Linux
machine before continuing.
Windows is currently not supported by the Portainer development environment.
Instructions
Navigate to the folder where you will store Portainer project code. This can be anywhere such as on your desktop or in your downloads folder.
Now, download the Portainer project:
1
git clone https://github.com/portainer/portainer.git
Copied!
Next, navigate into the Portainer project you downloaded:
1
cd portainer
Copied!
Install the development dependencies:
1
yarn
Copied!
And finally, build and run the project:
1
yarn start
Copied!
You should now be able to access Portainer at
https://localhost:9443
.
The frontend application will update when you save your changes to any of the sources. Just refresh the browser to see the changes.
Contribution Guidelines
When contributing to the Portainer codebase, please follow
our contribution guidelines
.
Contribute to Portainer - Previous
Contribute
Next
Set up a macOS build environment
Last modified
6mo ago
Copy link
Edit on GitHub
Contents
Instructions
Contribution Guidelines