Skip to content

Added a feature to define TUONI_CONTAINER_REPO env var that can be … #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sonsu wants to merge 1 commit into from
Closed

Added a feature to define TUONI_CONTAINER_REPO env var that can be … #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Tuoni is a cross-platform red teaming framework built for cyber defense exercise
## Prerequisites

- **OS:** Debian, Ubuntu, or Kali Linux
- **Architecture:** x86\_64 or ARM64
- **Architecture:** x86_64 or ARM64
- **Docker:** 25.0.0 or later — installed automatically if missing
- **Network:** Outbound internet access for the initial image pull
- `wget` or `curl` must be available
Expand Down Expand Up @@ -76,17 +76,18 @@ curl https://tuoni.sh | bash

### Environment Variables

| Variable | Default | Description |
|---|---|---|
| `SILENT` | _(unset)_ | Set to `1` to skip all interactive prompts |
| `NO_UPDATE` | _(unset)_ | Set to `1` to skip updating the app on re-run |
| `TUONI_USERNAME` | `tuoni` | Initial admin username |
| `TUONI_PASSWORD` | _(autogenerated)_ | Initial admin password |
| `TUONI_DOCKER_IPV6_ENABLED` | `false` | Enable IPv6 on the Docker network |
| `TUONI_REPO` ⚗️ | `https://github.com/shell-dot/tuoni.git` | Source repository override |
| `TUONI_BRANCH` ⚗️ | `main` | Branch to install from |
| `TUONI_VERSION` ⚗️ | _(unset)_ | Pin a specific version |
| `TUONI_SUDO_COMMAND` ⚗️ | `sudo -E` | Override the sudo invocation |
| Variable | Default | Description |
| --------------------------- | ---------------------------------------- | ---------------------------------------------- |
| `SILENT` | _(unset)_ | Set to `1` to skip all interactive prompts |
| `NO_UPDATE` | _(unset)_ | Set to `1` to skip updating the app on re-run |
| `TUONI_USERNAME` | `tuoni` | Initial admin username |
| `TUONI_PASSWORD` | _(autogenerated)_ | Initial admin password |
| `TUONI_DOCKER_IPV6_ENABLED` | `false` | Enable IPv6 on the Docker network |
| `TUONI_REPO` ⚗️ | `https://github.com/shell-dot/tuoni.git` | Source repository override |
| `TUONI_BRANCH` ⚗️ | `main` | Branch to install from |
| `TUONI_VERSION` ⚗️ | _(unset)_ | Pin a specific version |
| `TUONI_SUDO_COMMAND` ⚗️ | `sudo -E` | Override the sudo invocation |
| `TUONI_CONTAINER_REPO` ⚗️ | `ghcr.io` | Container registry or proxy for pulling images |

> ⚗️ Experimental — intended for development and testing only.

Expand Down
14 changes: 7 additions & 7 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ services:
profiles: ["app", "server"]
container_name: tuoni-server
hostname: tuoni-server
image: ghcr.io/shell-dot/tuoni/server:${VERSION}
image: ${TUONI_CONTAINER_REPO:-ghcr.io}/shell-dot/tuoni/server:${VERSION}
volumes:
- ./data/:/app/data/
- ./logs/server/:/app/logs/
Expand All @@ -45,7 +45,7 @@ services:
profiles: ["app", "client"]
container_name: tuoni-client
hostname: tuoni-client
image: ghcr.io/shell-dot/tuoni/client:${VERSION}
image: ${TUONI_CONTAINER_REPO:-ghcr.io}/shell-dot/tuoni/client:${VERSION}
user: 1000:100
environment:
- TUONI_CLIENT_PORT
Expand All @@ -58,7 +58,7 @@ services:
- ./plugins/client:/srv/user-defined-plugins/:ro
networks:
- tuoni-network

tuoni-client-nginx:
<<: *defaults
profiles: ["app", "client", "client-nginx"]
Expand All @@ -82,15 +82,15 @@ services:
profiles: ["app", "docs"]
container_name: tuoni-docs
hostname: tuoni-docs
image: ghcr.io/shell-dot/tuoni/docs:${VERSION}
image: ${TUONI_CONTAINER_REPO:-ghcr.io}/shell-dot/tuoni/docs:${VERSION}
networks:
- tuoni-network
- tuoni-network

tuoni-utility:
<<: *defaults
profiles: ["utility"]
container_name: tuoni-utility
hostname: tuoni-utility
image: ghcr.io/shell-dot/tuoni/utility:${VERSION}
image: ${TUONI_CONTAINER_REPO:-ghcr.io}/shell-dot/tuoni/utility:${VERSION}
networks:
- tuoni-network
- tuoni-network
30 changes: 20 additions & 10 deletions scripts/check-configuration.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,27 @@ if [[ ! -z "${TUONI_VERSION+x}" ]]; then
sed -i "s/VERSION=.*/VERSION=${TUONI_VERSION}/g" ${TUONI_ENV_FILE_PATH}
fi

# Check if TUONI_CONTAINER_REPO variable is set, update tuoni.env file if it is
if [[ "${TUONI_CONTAINER_REPO}" ]]; then
echo "INFO | TUONI_CONTAINER_REPO variable is set, updating tuoni.env file ..."
# Checking if TUONI_CONTAINER_REPO already exists in the file
if grep -q "^TUONI_CONTAINER_REPO=" "$TUONI_ENV_FILE_PATH"; then
# Update existing entry
sed -i "s|^TUONI_CONTAINER_REPO=.*|TUONI_CONTAINER_REPO=${TUONI_CONTAINER_REPO}|g" "$TUONI_ENV_FILE_PATH"
else
echo -e "\nTUONI_CONTAINER_REPO=${TUONI_CONTAINER_REPO}" >> "$TUONI_ENV_FILE_PATH"
fi
fi

# Check if TUONI_DOCKER_IPV6_ENABLED variable is set
if [ "$TUONI_DOCKER_IPV6_ENABLED" ]; then
if [ "${TUONI_DOCKER_IPV6_ENABLED}" ]; then
# Remove existing TUONI_DOCKER_IPV6_ENABLED entry
sed -i '/^TUONI_DOCKER_IPV6_ENABLED=/d' $TUONI_ENV_FILE_PATH

# Ensure the file ends with a newline before appending, only if the file is non-empty
if [ -s "$TUONI_ENV_FILE_PATH" ] && [ "$(tail -c 1 "$TUONI_ENV_FILE_PATH")" != "" ]; then
echo "" >> "$TUONI_ENV_FILE_PATH"
if grep -q "^TUONI_DOCKER_IPV6_ENABLED=" "$TUONI_ENV_FILE_PATH"; then
# Update existing entry
sed -i "s/^TUONI_DOCKER_IPV6_ENABLED=.*/TUONI_DOCKER_IPV6_ENABLED=$TUONI_DOCKER_IPV6_ENABLED/g" "$TUONI_ENV_FILE_PATH"
else
echo -e "\nTUONI_DOCKER_IPV6_ENABLED=$TUONI_DOCKER_IPV6_ENABLED" >> "$TUONI_ENV_FILE_PATH"
fi

echo "TUONI_DOCKER_IPV6_ENABLED=$TUONI_DOCKER_IPV6_ENABLED" >> $TUONI_ENV_FILE_PATH
fi

# Check if tuoni.yml file exists, create if not
Expand Down Expand Up @@ -66,7 +76,7 @@ fi
# Check if 'client' attribute exists, pre 0.3.2
if [[ ! $($PROJECT_ROOT/scripts/tools/yq '.client.port' $TUONI_CONFIG_FILE_PATH) =~ ^[0-9]+$ ]]; then
echo "INFO | 'client' attribute is missing or invalid in config, adding ..."
$PROJECT_ROOT/scripts/tools/yq '.client = load("'$TUONI_CONFIG_EXAMPLE_FILE_PATH'").client' --inplace $TUONI_CONFIG_FILE_PATH
$PROJECT_ROOT/scripts/tools/yq '.client = load("'$TUONI_CONFIG_EXAMPLE_FILE_PATH'").client' --inplace $TUONI_CONFIG_FILE_PATH
fi

# Ensure necessary directories exist
Expand All @@ -92,7 +102,7 @@ fi
# Ensure server keystore exists
if [ ! -f "$PROJECT_ROOT/ssl/server/server-selfsigned.keystore" ]; then
echo "INFO | ssl/server/server-selfsigned.keystore file not found, creating ..."

if [ -d "$PROJECT_ROOT/ssl/server/hsperfdata_root" ]; then
${TUONI_SUDO_COMMAND} rmdir "${PROJECT_ROOT}/ssl/server/hsperfdata_root"
fi
Expand Down