Add a list of prerequisites before building Core from source #2011
Conversation
|
|
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| 1. [NPM](https://github.com/npm/cli) | ||
| 2. [Yarn](https://classic.yarnpkg.com/en/docs/install) | ||
| 3. [Docker](https://www.docker.com/) (optional) | ||
| 4. [Go](https://go.dev/dl/) -- currently Go 1.24 is the maximum supported Go version. |
There was a problem hiding this comment.
If this is aiming to be comprehensive, should we mention git as well (and make itself, for that matter)?
There was a problem hiding this comment.
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.
|
|
||
| In order to run `make`, you need the following: | ||
|
|
||
| 1. [NPM](https://github.com/npm/cli) |
There was a problem hiding this comment.
I don't think npm is technically required, is it?
There was a problem hiding this comment.
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.
|
|
||
| 1. [NPM](https://github.com/npm/cli) | ||
| 2. [Yarn](https://classic.yarnpkg.com/en/docs/install) | ||
| 3. [Docker](https://www.docker.com/) (optional) |
There was a problem hiding this comment.
Might be nice to mention what you would need docker for — maybe something like this?
| 3. [Docker](https://www.docker.com/) (optional) | |
| 3. [Docker](https://www.docker.com/) (optional, used in some tests) |
| In order to run `make`, you need the following: | ||
|
|
||
| 1. [NPM](https://github.com/npm/cli) | ||
| 2. [Yarn](https://classic.yarnpkg.com/en/docs/install) |
There was a problem hiding this comment.
| 2. [Yarn](https://classic.yarnpkg.com/en/docs/install) | |
| 2. [Yarn 1.x](https://classic.yarnpkg.com/en/docs/install) |
Listing some tools I needed to install before I could build Pomerium Core. I debated mentioning
brewbut decided against, as that is Mac specific. The rest of these tools should apply to any (reasonable) OS.