Skip to content

xiaoyao9184/docker-surya

Repository files navigation

Docker Surya

A Docker image built through Github Actions with Git commit version tag

Why

I found that Surya's Docker image is difficult to find. The code on GitHub does not provide a pre-built Docker image.

After reviewing the following items

This project will use GitHub Actions and Docker Hub to build and publish images, aiming to keep the process as clean as possible without custom configuration files.

Tags

The images of this project will be published to Docker Hub under the repository xiaoyao9184/surya.

Since this project references the Surya project via a submodule, it cannot monitor push events on the Surya project, and therefore cannot automatically create an image for every commit. A good solution is to manually trigger the action and tag it with the commit id. For more details, see this article set-dynamic-parameters-github-workflows-en.

The default image name format is ${DOCKERHUB_USERNAME}/surya.

The tag uses the input parameter commit_id, which can be either a branch name or a commit id, when manually triggering the docker-image-tag-commit job. if the job is triggered by a submodule update push, the default branch name master will be used instead of the commit_id parameter. This job will also use the shortened commit id as the tag.

If the job docker-image-tag-version is triggered with the surya_version parameter set to the PyPI Surya version number, the Surya package published on PyPI will be installed for the build, and surya_version will be used as the tag.

Currently, only the linux/amd64 platform is supported.

Change

You can fork this project and build your own image. You will need to provide the following variables: DOCKERHUB_USERNAME, DOCKERHUB_TOKEN. See this for more details.

About

Docker implementation of the Surya OCR

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages