feat: Making clearer that env vars are shared along with source code#2414
feat: Making clearer that env vars are shared along with source code#2414
Conversation
|
Preview for this PR was built for commit |
There was a problem hiding this comment.
Pull request overview
Adds documentation clarifying that publishing an Actor makes its source code and non-secret environment variables visible on the Actor detail page, and explains how the “Hide source files from Actor detail” setting affects this.
Changes:
- Add a “Source code visibility” section to the Actor publishing guide.
- Add a caution admonition to the environment variables page about visibility for public Actors.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sources/platform/actors/publishing/publish.mdx | Documents default public visibility of source files and non-secret env vars after publishing, and how to hide them in Console settings. |
| sources/platform/actors/development/programming_interface/environment_variables.md | Adds a caution explaining that non-secret env vars can be publicly visible for published Actors and how the hide-source setting affects them. |
Co-authored-by: Copilot <[email protected]>
…ronment_variables.md Co-authored-by: Copilot <[email protected]>
|
Preview for this PR was built for commit |
TC-MO
left a comment
There was a problem hiding this comment.
Cleaned up prose & rephrased both additions for consistency
| :::caution Visibility of environment variables in public Actors | ||
|
|
||
| When you [publish your Actor](/platform/actors/publishing/publish), environment variables not marked as **Secret** in Apify Console are visible to anyone on the Actor detail page along with the source code. If you enable **Hide source files from Actor detail** in the Actor's **Settings**, environment variables not marked as **Secret** in Apify Console are hidden as well. | ||
|
|
||
| Secret environment variables are never exposed on the Actor detail page regardless of this setting. Always mark sensitive values as **Secret**. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
| :::caution Visibility of environment variables in public Actors | |
| When you [publish your Actor](/platform/actors/publishing/publish), environment variables not marked as **Secret** in Apify Console are visible to anyone on the Actor detail page along with the source code. If you enable **Hide source files from Actor detail** in the Actor's **Settings**, environment variables not marked as **Secret** in Apify Console are hidden as well. | |
| Secret environment variables are never exposed on the Actor detail page regardless of this setting. Always mark sensitive values as **Secret**. | |
| ::: | |
| :::caution Visibility of environment variables in public Actors | |
| When you [publish your Actor](/platform/actors/publishing/publish), environment variables not marked as **Secret** in Apify Console are visible to anyone on the Actor detail page alongside the source code. Enable **Hide source files from Actor detail** in the Actor's **Settings** to hide both. | |
| Apify Console never exposes secret environment variables on the Actor detail page, regardless of this setting. Always mark sensitive values as secret | |
| ::: |
|
|
||
| ## Source code visibility | ||
|
|
||
| When you publish an Actor, its source code files and non-secret [environment variables](/platform/actors/development/programming-interface/environment-variables) are publicly visible by default on the Actor detail page. | ||
|
|
||
| To hide them, go to your Actor's **Settings** tab in Apify Console and check **Hide source files from Actor detail**. Secret environment variables are never exposed regardless of this setting. |
There was a problem hiding this comment.
| ## Source code visibility | |
| When you publish an Actor, its source code files and non-secret [environment variables](/platform/actors/development/programming-interface/environment-variables) are publicly visible by default on the Actor detail page. | |
| To hide them, go to your Actor's **Settings** tab in Apify Console and check **Hide source files from Actor detail**. Secret environment variables are never exposed regardless of this setting. | |
| ## Source code visibility | |
| When you publish an Actor, its source code files and non-secret [environment variables](/platform/actors/development/programming-interface/environment-variables) are publicly visible by default on the Actor detail page. | |
| To hide them, go to your Actor's **Settings** tab in Apify Console and check **Hide source files from Actor detail**. Apify Console never exposes secret environment variables regardless of this setting. |
This was not mentioned at the right places, so adding it to the publication and env vars sections.