feat: add Actor Standby documentation #1086
Conversation
mhamas
commented
Jun 27, 2024
•
mhamas
commented
There was a problem hiding this comment.
Looks good, I left a few comments.
@jirimoravcik since Maťo is on vacation, can you check my suggestions, and if you're fine with them, just commit them?
There was a problem hiding this comment.
Ok, this needs to wait for public release 😅 Working on it, blocked by https://github.com/apify/apify-core/pull/16488
There was a problem hiding this comment.
Current screenshots can be taken from
https://console-featstandbypublicrelease-a00865.apify.com/
There was a problem hiding this comment.
This will look a bit different, currently in PR
| inputs and ouputs in your README. | ||
|
|
||
| #### Can I monetize my Actor in the Standby mode? | ||
| No, the Standby mode is currently in Beta and the monetization is not supported. |
There was a problem hiding this comment.
[To consider]: I am thinking that some readme example would be nice, with #actor-standby header
Co-authored-by: František Nesveda <[email protected]> Co-authored-by: Zuzana Štětinová <[email protected]>
Co-authored-by: TheoVasilis <[email protected]>
fix mdlint issues remove unnecessary words slight changes for clarity
jirimoravcik
changed the title
sources/platform/actors/running/images/actor_standby/standby-tab.png
Outdated
Show resolved
Hide resolved
|
|
||
| You can head to the Settings tab of your Actor, enable Standby mode, and set the default configuration. | ||
|  | ||
|
|
||
| For the coding part, you can use Apify SDK to retrieve the port Actor Standby should be listening on. |
There was a problem hiding this comment.
Can you talk here a bit more about how the Actors should behave internally before jumping straight to the code?
Sth like "Standby Actors should run a HTTP server listening on a specific port, to which the user requests will be proxied. This port is available in the Actor config object available in the Apify SDK."
| <Tabs> | ||
| <TabItem value="JavaScript" label="JavaScript"> | ||
|
|
||
| ```js | ||
| import { Actor } from 'apify'; | ||
|
|
||
| await Actor.init(); | ||
| console.log(Actor.config.get('standbyPort')); | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Python" label="Python"> | ||
|
|
||
| ```python | ||
| from apify import Actor, Configuration | ||
|
|
||
| async def main() -> None: | ||
| async with Actor: | ||
| config = Configuration.get_global_configuration() | ||
| print(config.standby_port) | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> |
There was a problem hiding this comment.
I would skip this and go straight for the example with the HTTP server, it's not too complicated, so there's no need to split it into two examples.
Co-authored-by: František Nesveda <[email protected]>
Co-authored-by: Jiří Moravčík <[email protected]> Co-authored-by: František Nesveda <[email protected]> Co-authored-by: Zuzana Štětinová <[email protected]> Co-authored-by: TheoVasilis <[email protected]> Co-authored-by: Michał Olender <[email protected]>
