Update docs with expose info
@@ -18,6 +18,7 @@ $ docker-compose up
- Releases can be found [here](https://github.com/creativesoftwarefdn/weaviate/releases).
- Based on `tree/master` on Github
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
#### Running the latest unstable version
@@ -28,6 +29,8 @@ $ docker-compose up
- Based on `tree/develop` on Github
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080.
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
#### Running a specific version
@@ -42,6 +45,7 @@ $ docker-compose up
```
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
## Run Weaviate stand alone with Docker
@@ -55,6 +59,7 @@ $ docker run creativesoftwarefdn/weaviate:stable
- Based on `tree/master` on Github
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
#### Specific Stable version
@@ -64,6 +69,7 @@ $ docker run creativesoftwarefdn/weaviate:$VERSION
- Releases can be found [here](https://github.com/creativesoftwarefdn/weaviate/releases).
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
#### Unstable
@@ -73,7 +79,18 @@ $ docker run creativesoftwarefdn/weaviate:unstable
- Based on `tree/davelop` on Github
- Runs with the latest open source Contextionary. More indepth information about the contextionary can be found [here](../contribute/contextionary.md).
+- Weaviate becomes available as HTTP service on port 8080 on `://{IP}/weaviate/v1/{COMMAND}`.
## Running with Custom Contextionary
More information about running Weaviate with a custom Contextionary can be found in the [`docs/en/contribute/running-weaviate.md`](docs/en/contribute/running-weaviate.md) docs.
+
+## Running with custom server configuration
+
+If you want to run Weaviate with a specific configuration (for example over SSL or a different port) you can take the following steps.
+
+```sh
+# Clone the repo
+$ git clone https://github.com/creativesoftwarefdn/weaviate
+# Select the correct branch,
+```
\ No newline at end of file
