yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-09-01 04:43:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README with notes about multi-platform (#433)

Browse Source
This commit is contained in:
ryannikolaidis 2023-04-01 17:31:32 -07:00 committed by GitHub
parent 414883455b
commit b746cb0ab4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -86,7 +86,7 @@ print("\n\n".join([str(el) for el in elements]))
The following instructions are intended to help you get up and running using Docker to interact with `unstructured`. The following instructions are intended to help you get up and running using Docker to interact with `unstructured`.
See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine. See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine.
NOTE: the image is only supported for x86_64 hardware and known to have issues on Apple silicon. NOTE: we build multi-platform images to support both x86_64 and Apple silicon hardware. `docker pull` should download the corresponding image for your architecture, but you can specify with `--platform` (e.g. `--platform linux/amd64`) if needed.
We build Docker images for all pushes to `main`. We tag each image with the corresponding short commit hash (e.g. `fbc7a69`) and the application version (e.g. `0.5.5-dev1`). We also tag the most recent image with `latest`. To leverage this, `docker pull` from our image repository. We build Docker images for all pushes to `main`. We tag each image with the corresponding short commit hash (e.g. `fbc7a69`) and the application version (e.g. `0.5.5-dev1`). We also tag the most recent image with `latest`. To leverage this, `docker pull` from our image repository.
@ -98,7 +98,7 @@ Once pulled, you can create a container from this image and shell to it.
```bash ```bash
# create the container # create the container
docker run --platform linux/amd64 -d -t --name unstructured quay.io/unstructured-io/unstructured:latest docker run -dt --name unstructured quay.io/unstructured-io/unstructured:latest
# this will drop you into a bash shell where the Docker image is running # this will drop you into a bash shell where the Docker image is running
docker exec -it unstructured bash docker exec -it unstructured bash