Zulip

https://zulip.readthedocs.io/en/stable/
Admin
Zulip is an open-source organized team chat platform with unique topic-based threading that combines...
Tokens:635,237
Snippets:11,829
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Zulip Development Environment (Windows VM)

Source: https://zulip.readthedocs.io/en/stable/_sources/development/setup-recommended.md.txt

Navigate to the Zulip directory and use Vagrant to start the development environment on Windows using a VM. Ensure Vagrant plugins are installed.

```console
$ cd zulip
$ vagrant plugin install vagrant-vbguest
$ vagrant up --provider=virtualbox
```

--------------------------------

### Provision and Run Zulip Development Server

Source: https://zulip.readthedocs.io/en/stable/_sources/development/setup-advanced.md.txt

After installing Python 3 (if necessary), provision the Zulip environment, activate the virtual environment, and start the development server.

```bash
# From inside a clone of zulip.git:
./tools/provision
source .venv/bin/activate
./tools/run-dev  # starts the development server
```

--------------------------------

### Install and Run Zulip Development Environment (Windows WSL)

Source: https://zulip.readthedocs.io/en/stable/_sources/development/setup-recommended.md.txt

Use these commands to install/update the Zulip development environment, activate the Python virtual environment, and start the development server on Windows using WSL.

```console
$ # Install/update the Zulip development environment
$ ./tools/provision
$ # Enter the Zulip Python environment
$ source .venv/bin/activate
$ # Start the development server
$ ./tools/run-dev
```

--------------------------------

### Install Zulip application frontend

Source: https://zulip.readthedocs.io/en/stable/_sources/production/postgresql.md.txt

Run the installer on the application server using the standalone_nodb profile.

```bash
./zulip-server-*/scripts/setup/install --certbot \
    --email=YOUR_EMAIL --hostname=YOUR_HOSTNAME \
    --puppet-classes=zulip::profile::standalone_nodb
```

--------------------------------

### Example Output of Run-Dev

Source: https://zulip.readthedocs.io/en/stable/_sources/development/setup-advanced.md.txt

This console output shows the information provided when the Zulip development server starts, including the main access URL and internal port details.

```console
Starting Zulip on:

     http://172.30.24.235:9991/

Internal ports:
   9991: Development server proxy (connect here)
   9992: Django
   9993: Tornado
   9994: webpack
```

--------------------------------

### Vagrant provisioning output example

Source: https://zulip.readthedocs.io/en/stable/development/setup-advanced.html

Example of the expected output during the Vagrant provisioning process.

```text
Bringing machine 'default' up with 'hyperv' provider...
==> default: Verifying Hyper-V is enabled...
==> default: Verifying Hyper-V is accessible...
<other stuff>...
==> default: Waiting for the machine to report its IP address...
    default: Timeout: 120 seconds
    default: IP: 172.28.119.70
==> default: Waiting for machine to boot. This may take a few minutes...
    default: SSH address: 172.28.122.156
==> default: Machine booted and ready!
==> default: Preparing SMB shared folders...
Vagrant requires administrator access for pruning SMB shares and
may request access to complete removal of stale shares.
==> default: Starting the machine...
<other stuff>...
 default: Username (user[@domain]): <your-machine-username>
 default: Password (will be hidden):
```

--------------------------------

### Example webhook URL with query parameters

Source: https://zulip.readthedocs.io/en/stable/webhooks/incoming-webhooks-reference.html

An example of a URL configured for a third-party service to trigger the webhook with specific query parameters.

```text
http://myhost/api/v1/external/querytest?api_key=abcdefgh&stream=alerts&topic=queries
```

--------------------------------

### Configure Gmail SMTP in dev-secrets.conf

Source: https://zulip.readthedocs.io/en/stable/subsystems/email.html

Example configuration for routing development emails through a Gmail SMTP server.

```ini
email_host = smtp.gmail.com
email_port = 587
email_host_user = username@gmail.com
email_use_tls = true

# This is different from your Gmail password if you have 2FA enabled for your Google account.
# See the configuring Gmail to send email section above for more details
email_password = gmail_password
```

--------------------------------

### Upgrade Ubuntu 16.04 to 18.04 Database and OS Configuration

Source: https://zulip.readthedocs.io/en/stable/production/upgrade.html

Run as root to update the database installation and OS configuration after the OS upgrade.

```bash
touch /usr/share/postgresql/10/pgroonga_setup.sql.applied
/home/zulip/deployments/current/scripts/zulip-puppet-apply -f
pg_dropcluster 10 main --stop
systemctl stop postgresql
pg_upgradecluster 9.5 main
pg_dropcluster 9.5 main
apt remove postgresql-9.5
systemctl start postgresql
systemctl restart memcached

```

--------------------------------

### Provision and Start Development Server

Source: https://zulip.readthedocs.io/en/stable/development/setup-advanced.html

Executes the provisioning script, activates the virtual environment, and launches the development server.

```bash
# From inside a clone of zulip.git:
./tools/provision
source .venv/bin/activate
./tools/run-dev  # starts the development server
```

--------------------------------

### Define Python API Example

Source: https://zulip.readthedocs.io/en/stable/documentation/api.html

Define a testable Python example using the openapi_test_function decorator. The code between the start and end comments is extracted for documentation.

```python
@openapi_test_function('/messages/render:post')
def render_message(client: Client) -> None:
    # {code_example|start}
    # Render a message
    request = {
        'content': '**foo**'
    }
    result = client.render_message(request)
    # {code_example|end}

    validate_against_openapi_schema(result, '/messages/render', 'post', '200')

```

--------------------------------

### Initialize Zulip with Vagrant (VM)

Source: https://zulip.readthedocs.io/en/stable/development/setup-recommended.html

Commands to prepare the directory and start the virtual machine environment on Windows.

```bash
$ cd zulip
$ vagrant plugin install vagrant-vbguest
$ vagrant up --provider=virtualbox
```

--------------------------------

### Identify Puppet connection error

Source: https://zulip.readthedocs.io/en/stable/_sources/production/install-existing-server.md.txt

Example of the error message encountered when a Puppet agent is active during installation.

```console
puppet-agent[29873]: Could not request certificate: Failed to open TCP connection to puppet:8140
```

--------------------------------

### Development server startup output

Source: https://zulip.readthedocs.io/en/stable/development/setup-advanced.html

Example output showing the server status and internal ports.

```text
Starting Zulip on:

     http://172.30.24.235:9991/

Internal ports:
   9991: Development server proxy (connect here)
   9992: Django
   9993: Tornado
   9994: webpack
```

--------------------------------

### Enable Certbot on existing Zulip installation

Source: https://zulip.readthedocs.io/en/stable/_sources/production/ssl-certificates.md.txt

Run the setup script to automate SSL certificate acquisition and renewal for a specific hostname.

```bash
sudo -s  # If not already root
/home/zulip/deployments/current/scripts/setup/setup-certbot --email=EMAIL HOSTNAME [HOSTNAME2...]
```

--------------------------------

### Define an endpoint path

Source: https://zulip.readthedocs.io/en/stable/documentation/openapi.html

Example of a Path Item Object defining a GET request for user presence, including parameters and response schema.

```yaml
/users/{user}/presence:
  get:
    description: Get presence data for another user.
    operationId: getPresence
    parameters:
    - name: user
      in: path
      description: Enter email address
      required: true
      type: string
    security:
    - basicAuth: []
    responses:
      '200':
        description: The response from a successful call
        schema:
          type: object
          required:
          - msg
          - result
          - presence
          properties:
            msg:
              type: string
            result:
              type: string
            presence:
              type: array
```

--------------------------------

### Install and create PostgreSQL database

Source: https://zulip.readthedocs.io/en/stable/_sources/production/postgresql.md.txt

Run these commands on the dedicated PostgreSQL host to set up the database server.

```bash
./zulip-server-*/scripts/setup/install \
    --puppet-classes=zulip::profile::postgresql

./zulip-server-*/scripts/setup/create-database
```

--------------------------------

### Endpoint Definition for User Presence

Source: https://zulip.readthedocs.io/en/stable/_sources/documentation/openapi.md.txt

Example of an endpoint definition in the Paths Object, detailing a GET request for user presence. It includes path parameters, security requirements, and the schema for the successful response.

```yaml
/users/{user}/presence:
  get:
    description: Get presence data for another user.
    operationId: getPresence
    parameters:
    - name: user
      in: path
      description: Enter email address
      required: true
      type: string
    security:
    - basicAuth: []
    responses:
      '200':
        description: The response from a successful call
        schema:
          type: object
          required:
          - msg
          - result
          - presence
          properties:
            msg:
              type: string
            result:
              type: string
            presence:
              type: array

```

--------------------------------

### Example CPU and RAM Allocation

Source: https://zulip.readthedocs.io/en/stable/_sources/development/setup-recommended.md.txt

Example configuration for allocating 4 CPUs and 8 GiB of memory to the Vagrant guest. Apply with 'vagrant reload'.

```text
GUEST_CPUS 4
GUEST_MEMORY_MB 8192
```
Tokens:
Raw