Installation Guide¶
1. Planning an Installation¶
- How to plan an installation
- Deployment options at a glance
- WIAB Dev (single-VM Wire-in-a-Box)
- WIAB Staging (multi-VM KVM-based test cluster)
- Production installation (persistent data, high-availability)
2. Version Requirements¶
3. Dependencies on Operator’s Machine¶
4. How to install Wire in a box (Dev)¶
- WIAB Dev (Wire-in-a-Box development) Deployment Guide
- Introduction
- What will be installed?
- Relation to WIAB Staging and Production
- Architecture overview
- Deployment requirements
- Getting Started
- Deployment Flow
- Ansible notes
- Troubleshooting
- Cleaning/Uninstalling Wire-in-a-Box
5. How to install Wire in a box (Staging)¶
- WIAB Staging Deployment Guide
- Introduction
- Architecture overview
- Relation to production
- Requirements
- VM Provisioning
- Getting the Ansible playbooks
- When VMs are ready
- Kubernetes & Data Services Deployment
- Helm Operations to install Wire services and supporting Helm charts
- Network Traffic Configuration
- Next steps and troubleshooting
6. Introduction¶
- Introduction
- What will be installed by following these parts?
- What will not be installed?
- What will not be installed by default?
- Getting support
- Next steps for high-available production installation
7. Installing Kubernetes and Databases¶
- Installing kubernetes and databases on VMs with ansible
- Introduction
- Downloading and extracting the artifact
- Editing the inventory
- Generating secrets for the services
- Deploying Kubernetes and stateful services
- Deploying secondary k8s cluster for calling services
- Post Installation checks
- Next steps for high-available production installation
8. Configuring AWS Services¶
- How to configure AWS services
- Introduction
- Using real AWS services for SNS
- Using real AWS services for SES / SQS
- Using real AWS services for S3
9. Installing Wire-Server using Helm¶
- How to install wire-server using Helm
- Introduction
- Prerequisites
- Preparing to install charts from the internet with Helm
- Watching changes as they happen
- General installation notes
- How to install charts that provide access to external databases
- Fake AWS (SNS/SQS) for websocket-only notifications (no FCM/APNS)
- Preparing to install wire-server
- How to install RabbitMQ
- How to configure real SMTP (email) services
- How to install fake SMTP (email) services
- How to install wire-server itself
- DNS records
10. Multi-Ingress Configuration¶
- How to configure a Wire deployment for Multi-Ingress
- What is a Multi-ingress setup?
- How is multi-ingress useful?
- Requirements
- Instructions
- Instructions for required changes in wire-server values
- Instructions for required changes in webapp values
- Instructions for required changes in nginx-ingress-services values
- Calling
- How to setup VPS for each domain between a client and wire-backend
11. Infrastructure Configuration¶
- Infrastructure configuration
- Redirect some traffic through a http(s) proxy
- Enable push notifications using the public appstore / playstore mobile Wire clients
- Controlling the speed of websocket draining during cannon pod replacement
- Control nginz upstreams (routes) into the Kubernetes cluster
- Separate incoming websocket network traffic from the rest of the https traffic
- You may want
- Metrics/logging
- SMTP server
- Load balancer on bare metal servers
- Load Balancer on cloud-provider
- Real AWS services
- Persistence and high-availability
- Security
- 3rd-party proxying
- Routing traffic to other namespaces via nginz
- Marking an installation as self-hosted
- Configuring authentication cookie throttling
- S3 Addressing Style
- I have a team larger than 500 users
12. Monitoring Wire-Server¶
13. Centralized Logs for Wire-Server¶
- How to see centralized logs for wire-server
- Introduction
- Status
- Prerequisites
- Installing required helm charts
- Configuring fluent-bit
- Post-install kibana setup
- Usage after installation
- Nuking it all.
- Debugging
14. Ingress-Controller (Getting Traffic In)¶
- Ingress-controller (getting traffic in)
- Installing in a cloud-like environment
- Installing on bare-metal without dynamic load balancer support
15. Web App Settings¶
- Web app settings
- Enforce desktop application only
- Enforce constant bit rate
- Disable media plugins
- Enable extra entropy (only on Windows)
16. Installing Conference Calling 2.0 (aka SFT)¶
17. Installing Restund¶
18. Configure TLS Ciphers¶
- Configure TLS ciphers
- Ingress Traffic (wire-server)
- Egress Traffic (wire-server/federation)
- SFTD (ansible)
- SFTD (kubernetes)
- Coturn (kubernetes)
- Restund (ansible)
- Restund (kubernetes)
19. Managing Authentication with Ansible¶
- Managing authentication with ansible
- How to use password authentication when you ssh to a machine with ansible
- Configuring SSH keys
- Sudo without password
20. Using Tinc¶
21. Troubleshooting During Installation¶
- Troubleshooting during installation
- Problems with CSP on the web based applications (webapp, team-settings, account-pages)
- Problems with ansible and python versions
- Flaky issues with Cassandra (failed QUORUMs, etc.)
- I deployed
demo-smtpbut I’m not receiving any verification emails - I deployed
demo-smtpand I want to skip email configuration and retrieve verification codes directly - Obtaining Brig logs, and the format of different team/user events
- Diagnosing and addressing bad network/disconnect issues
- Diagnosing issues with installation steps.
- Verifying correct deployment of DNS / DNS troubleshooting.