Skip to content

Add a list of prerequisites before building Core from source #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a list of prerequisites before building Core from source #2011

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/deploy/core.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ If you plan to run on port 443 in a rootless environment, you may need extra [ca

If you prefer building from source:

### Prerequisites

In order to run `make`, you need the following:

1. [NPM](https://github.com/npm/cli)
Copy link
Contributor

@kenjenkins kenjenkins Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think npm is technically required, is it?

Copy link

@rjbeers rjbeers Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find an npm reference, but our docker builds use the latest node LTS. I'm pretty sure if you try to install yarn without node, it will install node, so we can drop this line. I can't find any version requirements.

2. [Yarn](https://classic.yarnpkg.com/en/docs/install)
Copy link

@rjbeers rjbeers Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. [Yarn](https://classic.yarnpkg.com/en/docs/install)
2. [Yarn 1.x](https://classic.yarnpkg.com/en/docs/install)

3. [Docker](https://www.docker.com/) (optional)
Copy link
Contributor

@kenjenkins kenjenkins Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be nice to mention what you would need docker for — maybe something like this?

Suggested change
3. [Docker](https://www.docker.com/) (optional)
3. [Docker](https://www.docker.com/) (optional, used in some tests)

4. [Go](https://go.dev/dl/) -- currently Go 1.24 is the maximum supported Go version.
Copy link
Contributor

@kenjenkins kenjenkins Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is aiming to be comprehensive, should we mention git as well (and make itself, for that matter)?

Copy link

@rjbeers rjbeers Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need git or make, but if we have a minimum expected go version, i'd expect hat. This statement says 1.24 is the maximum supported version. Is that right or should it have said 1.24. I wouldn't expect 1.25 to break things.


### Building

1. **Clone the Repository**
```bash
git clone https://github.com/pomerium/pomerium.git $HOME/pomerium
Expand Down