From 16b0fce22584a0cd4bf33981c843485918040fd7 Mon Sep 17 00:00:00 2001 From: joshua Date: Mon, 20 Oct 2025 15:01:02 -0400 Subject: [PATCH] Add docker compose example --- home/modules/ROOT/pages/install/ce.adoc | 4 ++ home/modules/ROOT/pages/install/drivers.adoc | 8 ++-- home/modules/ROOT/partials/ce_docker.adoc | 46 +++++++++++++++++++- 3 files changed, 53 insertions(+), 5 deletions(-) diff --git a/home/modules/ROOT/pages/install/ce.adoc b/home/modules/ROOT/pages/install/ce.adoc index 9fea7ca0f..2ffd220de 100644 --- a/home/modules/ROOT/pages/install/ce.adoc +++ b/home/modules/ROOT/pages/install/ce.adoc @@ -32,6 +32,10 @@ include::{page-version}@home::partial$ce_docker.adoc[tag=start] include::{page-version}@home::partial$ce_docker.adoc[tag=stop] +=== Docker Compose + +include::{page-version}@home::partial$ce_docker.adoc[tag=docker-compose] + == Next steps Now that you have TypeDB server running, you can connect with xref:{page-version}@tools::studio.adoc[TypeDB Studio] or xref:{page-version}@tools::console.adoc[TypeDB Console], or install and use a xref:{page-version}@home::install/drivers.adoc[Driver]. \ No newline at end of file diff --git a/home/modules/ROOT/pages/install/drivers.adoc b/home/modules/ROOT/pages/install/drivers.adoc index b77871ec7..d787d2ffe 100644 --- a/home/modules/ROOT/pages/install/drivers.adoc +++ b/home/modules/ROOT/pages/install/drivers.adoc @@ -55,7 +55,7 @@ driver = TypeDB.driver(address=TypeDB.DEFAULT_ADDRESS, ...) === Python driver tutorial -* https://github.com/typedb/typedb-driver/python[typedb-driver/python on GitHub] - Read the TypeDB Python driver tutorial +* xref:{page-version}@examples::social-network.adoc[Read the Python app example] == TypeScript (HTTP) @@ -84,7 +84,7 @@ const driver = new TypeDBHttpDriver({ === TypeScript HTTP driver example -* https://github.com/typedb/typedb-examples/tree/master/webapp[TypeSpace: Social Network Webapp Example] - Explore the TypeScript HTTP driver example on GitHub +* xref:{page-version}@examples::social-network.adoc[Read the TypeScript webapp example] == Rust @@ -109,7 +109,7 @@ let driver = TypeDBDriver::new_core(TypeDBDriver::DEFAULT_ADDRESS).await.unwrap( === Rust driver tutorial -* https://github.com/typedb/typedb-driver/rust[typedb-driver/rust on GitHub] - Read the TypeDB Rust driver tutorial +* xref:{page-version}@examples::social-network.adoc[Read the Rust app example] == Java @@ -152,7 +152,7 @@ try (Driver driver = TypeDB.driver(TypeDB.DEFAULT_ADDRESS, new Credentials("admi === Java driver tutorial -* https://github.com/typedb/typedb-driver/java[typedb-driver/java on GitHub] - Read the TypeDB Java driver tutorial +* xref:{page-version}@examples::social-network.adoc[Read the Java app example] == Other languages diff --git a/home/modules/ROOT/partials/ce_docker.adoc b/home/modules/ROOT/partials/ce_docker.adoc index 5d985f776..2c66b3066 100644 --- a/home/modules/ROOT/partials/ce_docker.adoc +++ b/home/modules/ROOT/partials/ce_docker.adoc @@ -56,4 +56,48 @@ To stop a running Docker container: ---- docker stop typedb ---- -// end::stop[] \ No newline at end of file +// end::stop[] + +// tag::docker-compose[] + +Alternatively, you can use Docker Compose to run TypeDB CE. Create a `docker-compose.yml` file: + +[source,yaml] +---- +version: '3.8' + +services: + typedb: + image: typedb/typedb:latest + container_name: typedb + ports: + - "1729:1729" + - "8000:8000" + volumes: + - typedb-data:/opt/typedb-all-linux-x86_64/server/data + +volumes: + typedb-data: +---- + +To start TypeDB with Docker Compose: + +[source,bash] +---- +docker-compose up -d +---- + +To stop TypeDB: + +[source,bash] +---- +docker-compose down +---- + +[NOTE] +==== +If you are running the arm64 image, change the volume path to `/opt/typedb-all-linux-arm64/server/data`. +You can also replace `typedb-data` with a local path to mount a specific directory on your host machine. +==== + +// end::docker-compose[]