Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apify/apify-actor-docker
Base Docker images for Apify actors.
https://github.com/apify/apify-actor-docker
Last synced: 6 days ago
JSON representation
Base Docker images for Apify actors.
- Host: GitHub
- URL: https://github.com/apify/apify-actor-docker
- Owner: apify
- License: apache-2.0
- Created: 2017-05-22T15:21:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-16T11:51:15.000Z (18 days ago)
- Last Synced: 2024-12-24T22:36:34.944Z (9 days ago)
- Language: Dockerfile
- Homepage: https://hub.docker.com/u/apify
- Size: 502 KB
- Stars: 70
- Watchers: 10
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Apify base Docker images
Public Docker images for Apify Actor serverless platform (https://docs.apify.com/actor)
The sources for the images are present in subdirectories that are named as the corresponding
Docker image. For example, the `node` directory corresponds to the
[apify/actor-node](https://hub.docker.com/r/apify/actor-node/) Docker image.
The images are using the following tags:
| Tag | Description |
| -------- | -------------------------------------------- |
| `latest` | Well-tested production version of the image. |
| `beta` | Development version of the image. |
## Maintenance
In order to build and publish a new version of the Docker images,
open the Actions tab and find the Release Images workflow.
You can then run the workflow by providing the following inputs:
- A tag, which will be used to tag the image in DockerHub. Typically beta or latest.
- A version of the `apify` package that should be pre-installed in the images.
- A version of the `puppeteer` package that should be pre-installed in the images that use Puppeteer.
### Adding a new actor image
To create a new image, which is not yet published in Apify DockerHub organization.
You need access to the organization and rights to create a new repository.
After, you need to follow these steps:
1. Create a new folder with the same name as the package you want to create without the prefix `actor-`.
For image `apify/actor-node`, create folder `node`.
2. Create a source of the image in that folder. Remember to create a test that is runnable using docker run to be able to test in the image in CI/CD.
3. Create a new repository in the Apify DockerHub organization, use the name with `actor-` prefix, e.g. `apify/actor-node`.
4. Give permission Read & Write to create image for devs groups in the Apify DockerHub organization.
5. Create a GitHub workflow which builds, tests and publishes the image into the DockerHub.
### Testing images locally
You will need the following tools installed: docker, make, jq, git
1. Clone this repository
1. Run `make all` to test out all images (this will take a long while, be patient).
You can overwrite the node version you build the images for by specifying `NODE_VERSION=xx` environment variable.
You can overwrite the playwright version you build the images for by specifying `PLAYWRIGHT_VERSION=vx.x.x-` environment variable. You must respect the format of `v-`
You can overwrite the puppeteer version you build the images for by specifying `PUPPETEER_VERSION=x.x.x` environment variable. You must respect the format of ``
1. If you want to run a specific test, call it with `make `. Run `make what-tests` to see what tests are available.