Skip to content

Commit 51a2adb

Browse files
committed
more updates
1 parent 99ac9cb commit 51a2adb

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/user/api-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The following sections describe how to get the Turbinia API server up and runnin
99
### Installation
1010
To use the Turbinia API server you will need to deploy Turbinia in your environment with a configuration that uses Redis and Celery.
1111

12-
Please follow the instructions for deploying a [Turbinia GKE Celery cluster](https://github.com/google/osdfir-infrastructure/tree/main/charts/turbinia) or [local stack using Celery](turbinia-local-stack.md)
12+
Please follow the [instructions](install.md) for deploying Turbinia to Kubernetes or Docker.
1313

1414
Note that the Turbinia API server requires access to the Turbinia output directory (```OUTPUT_DIR```)
1515

docs/user/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ User documentation
66
:maxdepth: 3
77

88
install
9-
turbinia-local-stack
109
how-it-works
1110
api-server
1211
turbinia-web-ui

docs/user/install.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ which will be covered in this guide.
1010

1111
To get started quickly, ensure you have [Helm](https://helm.sh/docs/intro/install/)
1212
and [Kubectl](https://kubernetes.io/docs/tasks/tools/) installed and are authenticated
13-
to your Kubernetes cluster.
13+
to your Kubernetes cluster. Please use the [init-gke.sh](https://github.com/google/osdfir-infrastructure/blob/main/tools/init-gke.sh) script for assistance
14+
initializing a Google Kubernetes Cluster.
1415

1516
Once complete, add the repo containing the Helm charts as follows:
1617

@@ -65,8 +66,8 @@ intend to start developing please [fork](https://docs.github.com/en/github/getti
6566
the repository on github first and check out your own forked instance.
6667

6768
```console
68-
$ git clone https://github.com/google/turbinia.git
69-
$ cd turbinia
69+
git clone https://github.com/google/turbinia.git
70+
cd turbinia
7071
```
7172

7273
#### Step 2
@@ -75,24 +76,24 @@ Generate configuration file using sed with default local stack values to the ```
7576
This folder (and supporting folders) will be mapped by docker compose into the containers.
7677

7778
```console
78-
$ mkdir -p ./conf && mkdir -p ./tmp && mkdir -p ./evidence && mkdir -p ./certs && chmod 777 ./conf ./tmp ./evidence ./certs
79-
$ sed -f docker/local/local-config.sed turbinia/config/turbinia_config_tmpl.py > conf/turbinia.conf
79+
mkdir -p ./conf && mkdir -p ./tmp && mkdir -p ./evidence && mkdir -p ./certs && chmod 777 ./conf ./tmp ./evidence ./certs
80+
sed -f docker/local/local-config.sed turbinia/config/turbinia_config_tmpl.py > conf/turbinia.conf
8081
```
8182

8283
#### Step 3
8384

8485
Let's bring up the local Turbinia stack
8586

8687
```console
87-
$ docker-compose -f ./docker/local/docker-compose.yml up
88+
docker-compose -f ./docker/local/docker-compose.yml up
8889
```
8990

9091
Redis, a Turbinia server and worker should now be running on your local system
9192
and a local persistent 'evidence' folder will have been created containing the
9293
Turbinia log file and processing output.
9394
> **Note**: Redis will store it's data in a volume that is mapped to ```./redis-data/```. You can adjust this in the docker-compose.yml configuration.
9495
95-
#### Step 4
96+
## Processing Evidence
9697

9798
Let's process evidence to test your setup, eg a Chrome Browser history file.
9899

0 commit comments

Comments
 (0)