mirror of
https://github.com/portainer/portainer.git
synced 2025-08-05 22:05:23 +02:00
docs(build): update contrib guidelines to use makefile [EE-5519] (#8997)
This commit is contained in:
parent
96de026eba
commit
2347133438
2 changed files with 18 additions and 10 deletions
|
@ -79,25 +79,33 @@ The feature request process is similar to the bug report process but has an extr
|
|||
|
||||
Ensure you have Docker, Node.js, yarn, and Golang installed in the correct versions.
|
||||
|
||||
Install dependencies with yarn:
|
||||
Install dependencies:
|
||||
|
||||
```sh
|
||||
$ yarn
|
||||
$ make deps
|
||||
```
|
||||
|
||||
Then build and run the project in a Docker container:
|
||||
|
||||
```sh
|
||||
$ yarn start
|
||||
$ make dev
|
||||
```
|
||||
|
||||
Portainer can now be accessed at <https://localhost:9443>.
|
||||
Portainer server can now be accessed at <https://localhost:9443>. and UI dev server runs on <http://localhost:8999>.
|
||||
|
||||
if you want to build the project you can run:
|
||||
|
||||
```sh
|
||||
make build
|
||||
```
|
||||
|
||||
For additional make commands, run `make help`.
|
||||
|
||||
Find more detailed steps at <https://docs.portainer.io/contribute/build>.
|
||||
|
||||
### Build customisation
|
||||
### Build customization
|
||||
|
||||
You can customise the following settings:
|
||||
You can customize the following settings:
|
||||
|
||||
- `PORTAINER_DATA`: The host dir or volume name used by portainer (default is `/tmp/portainer`, which won't persist over reboots).
|
||||
- `PORTAINER_PROJECT`: The root dir of the repository - `${portainerRoot}/dist/` is imported into the container to get the build artifacts and external tools (defaults to `your current dir`).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue