Skip to content

Commit a2b78a5

Browse files
docs: improve AIRBYTE_ENTRYPOINT requirements with absolute path guidance (#64943)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent dcf83a2 commit a2b78a5

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/platform/understanding-airbyte/airbyte-protocol-docker.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ The `write` command will consume `AirbyteMessage`s from STDIN.
5858

5959
The Docker image must contain an environment variable called `AIRBYTE_ENTRYPOINT`. This must be the same as the `ENTRYPOINT` of the image.
6060

61+
**Important**: The `AIRBYTE_ENTRYPOINT` environment variable must use absolute paths to ensure proper execution. Note that the Airbyte platform may change the working directory at runtime (for instance, to `/source` for sources and `/dest` for destinations). Using relative paths in the entrypoint can cause execution failures when the working directory is overridden.
62+
63+
**Example**:
64+
- ✅ Correct: `ENV AIRBYTE_ENTRYPOINT="python /airbyte/integration_code/main.py"`
65+
- ❌ Incorrect: `ENV AIRBYTE_ENTRYPOINT="./main.py"`
66+
6167
## Non-Root User: `airbyte`
6268

6369
The Docker image should run under a user named `airbyte`.

docusaurus/platform_versioned_docs/version-1.7/understanding-airbyte/airbyte-protocol-docker.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ The `write` command will consume `AirbyteMessage`s from STDIN.
5858

5959
The Docker image must contain an environment variable called `AIRBYTE_ENTRYPOINT`. This must be the same as the `ENTRYPOINT` of the image.
6060

61+
**Important**: The `AIRBYTE_ENTRYPOINT` environment variable must use absolute paths to ensure proper execution. Note that the Airbyte platform may change the working directory at runtime (for instance, to `/source` for sources and `/dest` for destinations). Using relative paths in the entrypoint can cause execution failures when the working directory is overridden.
62+
63+
**Example**:
64+
- ✅ Correct: `ENV AIRBYTE_ENTRYPOINT="python /airbyte/integration_code/main.py"`
65+
- ❌ Incorrect: `ENV AIRBYTE_ENTRYPOINT="./main.py"`
66+
6167
## Non-Root User: `airbyte`
6268

6369
The Docker image should run under a user named `airbyte`.

0 commit comments

Comments
 (0)