Skip to content

Commit bf70466

Browse files
docs: remove documentation changes that are in a separate PR
1 parent 1e7cf12 commit bf70466

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

heka-identity-service/docs/setup.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,22 @@ To run Heka Identity Service locally, follow these steps:
2222
```bash
2323
yarn install
2424
```
25-
> **Note for Python 3.12+ users:**
26-
> Building native dependencies like `@2060.io/ffi-napi` requires `node-gyp`, which relies on `distutils`—a module that was permanently removed in Python 3.12. If `yarn install` crashes with a `ModuleNotFoundError: No module named 'distutils'`, you must use Python 3.11 instead. You can do this without changing your system default by passing the environment variable:
27-
>
28-
> ```bash
29-
> npm_config_python=/path/to/python3.11 yarn install
30-
> ``
25+
### Fixing node-gyp issues with Python 3.12
26+
27+
If you encounter `node-gyp` build failures with Python 3.12,
28+
you have two options:
29+
30+
**Option 1 — Install setuptools (recommended)**
31+
Python 3.12 removed `distutils` which node-gyp depends on.
32+
Installing `setuptools` restores it:
33+
```bash
34+
pip install setuptools
35+
```
36+
**Option 2 — Use Python 3.11**
37+
Downgrade or switch your active Python version to 3.11:
38+
```bash
39+
npm install --python=python3.11
40+
```
3141
5. Configure persistent storage. You can find information on how to configure it in the [Persistence](#persistence)
3242
and [Migrations](#migrations) sections.
3343
6. Run the server as described in the [Run the app](#run-the-app)

0 commit comments

Comments
 (0)