Skip to content

Commit d5a0fce

Browse files
docs: update readme with notes about pulling and running the public Docker image. (#381)
1 parent fbc7a69 commit d5a0fce

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,42 @@ print("\n\n".join([str(el) for el in elements]))
8383

8484
## :dizzy: Instructions for using the docker image
8585

86-
The following instructions are intended to help you get up and running using docker to interact with `unstructured`.
86+
The following instructions are intended to help you get up and running using Docker to interact with `unstructured`.
87+
See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine.
88+
89+
NOTE: the image is only supported for x86_64 hardware and known to have issues on Apple silicon.
90+
91+
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.
92+
93+
```bash
94+
docker pull quay.io/unstructured-io/unstructured:latest
95+
```
96+
97+
Once pulled, you can create a container from this image and shell to it.
98+
99+
```bash
100+
# create the container
101+
docker run --platform linux/amd64 -d -t --name unstructured quay.io/unstructured-io/unstructured:latest
102+
103+
# this will drop you into a bash shell where the Docker image is running
104+
docker exec -it unstructured bash
105+
```
106+
107+
You can also build your own Docker image.
87108

88109
If you only plan on parsing one type of data you can speed up building the image by commenting out some
89110
of the packages/requirements necessary for other data types. See Dockerfile to know which lines are necessary
90111
for your use case.
91112

92-
See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine.
93-
94113
```bash
95114
make docker-build
96115

97-
# this will drop you into a bash shell where the docker image is running
116+
# this will drop you into a bash shell where the Docker image is running
98117
make docker-start-bash
118+
```
99119

120+
Once in the running container, you can try things out directly in Python interpreter's interactive mode.
121+
```bash
100122
# this will drop you into a python console so you can run the below partition functions
101123
python3
102124

0 commit comments

Comments
 (0)