docs: add developing with dev containers (#8095)

# Which Problems Are Solved

Describes how to develop ZITADEL using dev containers.

# Additional Changes

Sets default env variables for using postgres as database in the dev
container.

.devcontainer/docker-compose.yml

@@ -7,7 +7,17 @@ services:
       - /var/run/docker.sock:/var/run/docker.sock
     network_mode: service:db
     command: sleep infinity
-
+    environment:
+      - 'ZITADEL_DATABASE_POSTGRES_HOST=db'
+      - 'ZITADEL_DATABASE_POSTGRES_PORT=5432'
+      - 'ZITADEL_DATABASE_POSTGRES_DATABASE=zitadel'
+      - 'ZITADEL_DATABASE_POSTGRES_USER_USERNAME=zitadel'
+      - 'ZITADEL_DATABASE_POSTGRES_USER_PASSWORD=zitadel'
+      - 'ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE=disable'
+      - 'ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME=postgres'
+      - 'ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD=postgres'
+      - 'ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE=disable'
+      - 'ZITADEL_EXTERNALSECURE=false'
   db:
     image: postgres:latest
     restart: unless-stopped

CONTRIBUTING.md

@@ -141,6 +141,20 @@ Replace "policeman" with "police officer," "manpower" with "workforce," and "bus
 Ableist language includes words or phrases such as crazy, insane, blind to or blind eye to, cripple, dumb, and others.
 Choose alternative words depending on the context.
 
+### Developing ZITADEL with Dev Containers
+
+Follow the instructions provided by your code editor/IDE to initiate the development container. This typically involves opening the "Command Palette" or similar functionality and searching for commands related to "Dev Containers" or "Remote Containers". The quick start guide for VS Code can found [here](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container)
+
+When you are connected to the container run the following commands to start ZITADEL.
+
+```bash
+make compile && ./zitadel start-from-init --masterkey MasterkeyNeedsToHave32Characters --tlsMode disabled
+```
+
+ZITADEL serves traffic as soon as you can see the following log line:
+
+`INFO[0001] server is listening on [::]:8080`
+
 ### Backend/login
 
 By executing the commands from this section, you run everything you need to develop the ZITADEL backend locally.

docs/docs/self-hosting/deploy/devcontainer.mdx

@@ -0,0 +1,33 @@
+---
+title: Developing ZITADEL with Dev Containers
+sidebar_label: Dev Containers
+---
+
+Dev containers provide a convenient way to set up a development environment for ZITADEL with all the necessary dependencies pre-configured. This allows you to start contributing or working on ZITADEL locally with minimal setup.
+
+## Prerequisites
+
+- Docker installed on your machine. You can find installation instructions for Docker on their official website: https://docs.docker.com/engine/install/
+- A code editor or IDE with remote container development capabilities (optional, but recommended). [Visual Studio Code](https://code.visualstudio.com) with the [Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) is a popular option.
+
+## Setting Up Dev Container
+
+
+ZITADEL provides a `.devcontainer` folder that configures the development environment within a container. Here's how to get started:
+
+1. Clone the ZITADEL repository from GitHub:  
+```bash
+git clone https://github.com/zitadel/zitadel.git
+```
+2. Navigate to the project directory:  
+```bash
+cd zitadel
+```
+3. Open the project in your code editor or IDE (if using one with remote container support).
+4. Follow the instructions provided by your code editor/IDE to initiate the development container. This typically involves opening the "Command Palette" or similar functionality and searching for commands related to "Dev Containers" or "Remote Containers". The quick start guide for VS Code can found [here](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container)
+
+**Note**: The first time you run this command, it might take some time to download the container image.
+
+## Using Dev Container
+
+Once the container is running, you will have a development environment set up with all the necessary dependencies pre-installed. You can then follow the instructions in the ZITADEL [contribution guide](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#developing-zitadel-with-dev-containers) to build and run ZITADEL, or develop the ZITADEL console application.

docs/sidebars.js

@@ -843,6 +843,7 @@ module.exports = {
         "self-hosting/deploy/linux",
         "self-hosting/deploy/macos",
         "self-hosting/deploy/compose",
+        "self-hosting/deploy/devcontainer",
         "self-hosting/deploy/knative",
         "self-hosting/deploy/kubernetes",
         "self-hosting/deploy/loadbalancing-example/loadbalancing-example",