Unstructured-IO / Unstructured-IO/unstructured-api

Docker Env Vars and Tags

Open
#387 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
951
Forks
192
Avg merge
7d 8h
Merged PRs (30d)
2

Description

Hi,
would it be possible for someone to add a table to the readme with all of the environment variables that are possible to configure for the api docker image?

I am trying to set up unstructured with docker compose for using when developing/contributing to https://github.com/homanp/superagent

A table with the env var name, default value and a description of what it does with examples of the possible values?
Here are the vars I have managed to find so far:

Environment Variables

PORT: 8000
HOST: 0.0.0.0
UNSTRUCTURED_PARALLEL_MODE_ENABLED: false
UNSTRUCTURED_PARALLEL_MODE_URL:
UNSTRUCTURED_PARALLEL_MODE_THREADS: 3
UNSTRUCTURED_PARALLEL_MODE_SPLIT_SIZE: 1
UNSTRUCTURED_PARALLEL_RETRY_ATTEMPTS: 2
UNSTRUCTURED_API_KEY: ${UNSTRUCTURED_IO_API_KEY}
UNSTRUCTURED_MEMORY_FREE_MINIMUM_MB: 2048
SCARF_NO_ANALYTICS: false
DO_NOT_TRACK: false

Docker tags/releases

Additionally, where can I browse the list of available docker tags/releases? I would like to pin my deployment of the API docker image to the latest stable release, rather than pull 'latest' to give me a bit more control of the stability going forward.

I'd prefer not to have to figure out the tag manually, rather be able to script retrieval of the latest stable release tag.
Many thanks.

EDIT:
I figured out how to list the available docker images using curl

curl https://downloads.unstructured.io/v2/unstructured-io/unstructured-api/tags/list
This returns a list of images in the following format.
problem - there does not seem to be any releases for a long time, last version tagged here is 0.0.13, when latest at time of writing is 0.0.65

{
  "name": "unstructured-io/unstructured-api",
  "tags": [
    "45bd6d0",
    "5585edc",
    "ba21ebf",
    "809e207",
    "65b0c5f",
    "6e7f0e6",
    "b2077d0",
    "0.0.4",
    "f6bed4a",
    "0a704f8",
    "586e34e",
    "6752316",
    "0.0.5",
    "bc7f252",
    "0.0.6",
    "3e5e4ac",
    "b066bd7",
    "0.0.7",
    "6be1bf4",
    "ab008bf",
    "2bb000b",
    "0d13f98",
    "6bb9cba",
    "91793fb",
    "acaab4a",
    "4bfadb7",
    "37f0fb5",
    "0.0.8",
    "1c68185",
    "0.0.9",
    "90b6618",
    "64c50c4",
    "e5d75b4",
    "43f5162",
    "0.0.10",
    "0d77d43",
    "0.0.11",
    "186db76",
    "7b7f046",
    "2d87a58",
    "b65d1ac",
    "2f7e29c",
    "0.0.12",
    "67f0f40",
    "48d30b7",
    "0.0.13",
    "d01843c",
    "1ee29f3",
    "5fa72f3",
    "e53bd2e"
  ]
}


Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and the API Docker image configuration. Document the available environment variables with defaults, descriptions, and example values, then verify how stable image tags and releases are exposed. Done means the README covers both configuration and reliable tag or release discovery.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, python
Domain
devops, documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.