Skip to main content

Publish your Actor

Prepare your Actor for Apify Store with a description and README file, and learn how to make your Actor available to the public.

Before you make your Actor public, it is important to make sure your Actor has good Description and README sections so that users can understand what your Actor does, how to configure its inputs, and what kind of output it returns. In this lesson, we will briefly review each field you must fill in before publishing your Actor. For more detailed information about SEO and promotion and how to write a comprehensive README, check our guides at Apify Developer Academy.

You can find the Title and description configurations by going to Apify Console → Actors → My Actors → your-actor → Settings → Publication

Actor publication settings

Description​

The Actor's description is a short paragraph describing the Actor's purpose. It will be displayed on the Actor's page right below its title.

Actor title and description

While writing your Actor's description, you also have the option to write an SEO title and description. The SEO title and description are used in place of the Actor name and description on search engine results pages. Good SEO titles and descriptions utilize popular keywords, summarize the Actor functionality, and are between 40–50 and 140–156 characters long respectively.

SEO title and description

README​

The next step is to include a README detailing the Actor's features, reasons to scrape the target website, and an explanation of how to use the Actor.

Keep in mind that the Actor's README is generated from your README.md file, and you can apply the same SEO principles described in the previous lesson to your README.

To save some time when writing an Actor's README, you can use the template below as a starting point:

https://github.com/zpelechova/readme-template

Note that the complexity of the README should match the Actor's complexity. This means that the template above is not immutable and that you can adapt it to fit the particularities of your Actor.

Make your Actor Public​

Once you have finished coding and testing your Actor, it's time to publish it.

From your Actor's page in Apify Console, go to Publication → Display information, fill in all the relevant fields for your Actor (e.g., "Icons","Actor name", "Description", "Categories") and save it.

Actor settings

Once all the fields are filled in, you will notice that the button Publish to Store will turn green. Just click on it and your Actor should now be available to the public on Apify Store.

Publish your Actor

To check if everything went smoothly, you can go to Apify Store and search for your Actor's name.

Apify Store

Then, click on your Actor's card to see your dedicated Actor's page. This is the page where users will most likely have their first contact with your Actor, so make sure to carefully review it and check if everything is set up correctly.

Actor page