Cheat Sheet - Fabric Web Studio – Docker Compose Installation

Prerequisites

• Obtain a login account for docker.share.cloud.k2view.com
• Install Docker & Docker Compose plugin (not the deprecated docker-compose binary).
• If installing on Windows, use WSL2 and install under a Linux distribution (not under /mnt/c).
• Internet access is required to pull images from K2view's container registry unless using offline image loading.

Package Contents

• README.html – Documentation
• k2space.sh – Script to create/start/stop spaces
• .env – Configures Fabric and Git integration
• compose.yaml – Base Compose config
• studio_*.config – Studio profiles (e.g., studio_pg, studio_cass)
• tls-config.yaml, common.config, .env-tdmspace, etc.

Key Configurations

• Git Integration (optional): Define GIT_REPO, GIT_BRANCH, GIT_TOKEN, and GIT_USERNAME in .env
• TLS Certificates (optional): Replace default certs in ssl-certs/ (cert.cer, cert.key)

Important Notes

• Default credentials: admin / admin
• Persistent data is stored under persistent-data/<space-name>
• Container runtime storage: Ensure that the filesystem used by Docker/containerd has sufficient free space for Fabric Web Studio container images and extracted layers. The container runtime storage may reside on a different filesystem from the Studio installation directory. See Docker and Docker Compose Installation for details.
• In doubt? Consult the installation instructions.

Installation Steps

1. Install Docker and Docker Compose

Use Docker Desktop (includes Compose) or install via your package manager. See: Docker and Docker Compose Installation

2. Set Up Environment

Create a base directory (e.g., ~/K2view or /opt/K2view).
On Windows (WSL), avoid using /mnt/c; use /home/<user>/K2view.

mkdir -p ~/K2view
cd ~/K2view

3. Download the Studio Package

# Download and extract to ~/K2view
wget -c -O Studio-Docker-latest.zip 'https://download.k2view.com/index.php/s/hBv6Xz8bP9K8fwm/download'
unzip Studio-Docker-latest.zip
mv Studio-Docker Studio

4. Configure Git & TLS (Optional)

Edit ~/K2view/Studio/.env to include:

GIT_REPO=<your_repo>
GIT_BRANCH=main
GIT_TOKEN=<your_token>
GIT_USERNAME=<your_user>

TLS: Replace ssl-certs/cert.cer and ssl-certs/cert.key with your PEM-formatted certs.

5. Select a Fabric Web Studio Profile

Available profiles:

• studio (default, SQLite)
• studio_pg (PostgreSQL)
• studio_cass (Cassandra)
• studio_pg_cass (PostgreSQL + Cassandra)

6. Login to K2view Container Registry

docker login -u <your_user> https://docker.share.cloud.k2view.com

7. Create and Launch a Space

Make script executable:

cd Studio
chmod 700 k2space.sh
chmod 644 *.config

Create a space:

./k2space.sh create <space_name>
# Optional: Specify profile
./k2space.sh create --profile=studio_pg <space_name>

8. Access Web Studio

• Local: http://localhost/<space_name>
• Remote: https://<host>/<space_name> For remote access, you need to configure TLS. See Step 4. Login with:

Username: admin
Password: admin

Upgrading the Docker Compose Package

The Fabric Web Studio for Docker Compose package is updated periodically to add new capabilities and support newer Fabric and Web Studio versions. Upgrading a Fabric Web Studio Space does not update the Docker Compose package itself. Keep the package current so that you have the latest k2space.sh, configuration files, and supported upgrade capabilities. Before upgrading a Space, review the package upgrade procedure: Upgrading the Fabric Web Studio for Docker Compose Package After updating the package, use the supported Space upgrade procedure: Upgrading Fabric Web Studio Spaces

Offline Docker Image Download (If No Internet)

Offline Package Download Instructions

Operating

Operating Instructions.

Troubleshooting

Troubleshooting Instructions.