Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
b4ef524
update: wpb-22590 planning page for Wire server deploy and update the…
mohitrajain Mar 4, 2026
480b3f3
Apply suggestions from code review
mohitrajain Mar 5, 2026
b96976a
fix: update wiab-dev architecture diagram
mohitrajain Mar 5, 2026
029d311
fix: update wiab-stag architecture diagram
mohitrajain Mar 5, 2026
963093a
fix: update planning.md
mohitrajain Mar 5, 2026
b50deaf
fix the artifact documentation
mohitrajain Mar 6, 2026
ab96ac5
update readme.md section for planning
mohitrajain Mar 6, 2026
a92ded8
fix: wpb-22590 structure of planning doc
mohitrajain Mar 19, 2026
d87f7a8
add page for wiab-staging.md page
mohitrajain Mar 6, 2026
7e9771e
update readme.md section for wiab-staging.md
mohitrajain Mar 6, 2026
b858110
wpb-22590: update mkdocs for wiab-stag page
mohitrajain Mar 9, 2026
7c673a4
wpb-22590: update wiab-staging
mohitrajain Mar 16, 2026
16d7710
Update src/how-to/install/wiab-staging.md
mohitrajain Mar 24, 2026
44b0d61
Apply suggestions from code review
mohitrajain Mar 30, 2026
af92a75
staging, not stag.
julialongtin Jul 7, 2026
586b357
fix formatting.
julialongtin Jul 8, 2026
521635c
fix image link.
julialongtin Jul 17, 2026
7702be8
wpb-22590: add wiab-dev.md to replace older demo-wiab.md documentation
mohitrajain Mar 9, 2026
a929404
wpb-22590: update mkdocs for wiab-dev page
mohitrajain Mar 9, 2026
ae7d78d
wpb-22590: update doc to mention as luck is not involved in the business
mohitrajain Mar 16, 2026
0715373
Apply suggestions from code review
mohitrajain Mar 18, 2026
3e6c17f
fix: wpb-22590 add pages for ansible operations in production and int…
mohitrajain Mar 19, 2026
e74da5b
Update src/how-to/install/ansible-VMs.md
mohitrajain Mar 20, 2026
801ba52
Apply suggestions from code review
mohitrajain Jul 17, 2026
b1d0c8a
add: WPB-23988 made changes based on comments in PR
mohitrajain Jul 17, 2026
a3d17f2
add: WPB-23988 added inventory verification and ssh user auth documen…
mohitrajain Jul 20, 2026
cabe0b1
add: WPB-23988 synced with wire-server-deploy/wiab-staging.md
mohitrajain Jul 20, 2026
bccd92a
add: WPB-23988 update the broken links in all the pages related to re…
mohitrajain Jul 21, 2026
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
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ nav:
- How to plan an installation: how-to/install/planning.md
- Version requirements: how-to/install/version-requirements.md
- Dependencies on operator’s machine: how-to/install/dependencies.md
- How to install Wire in a box (Demo): how-to/install/demo-wiab.md
- How to install Wire in a box (Dev): how-to/install/wiab-dev.md
- How to install Wire in a box (Staging): how-to/install/wiab-staging.md
- Introduction: how-to/install/prod-intro.md
- How to install kubernetes and databases: how-to/install/ansible-VMs.md
- How to configure AWS services: how-to/install/aws-prod.md
Expand Down
101 changes: 61 additions & 40 deletions src/how-to/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

## 1. Planning an Installation
- [How to plan an installation](planning.md)
- [Demo installation (trying functionality out)](planning.md#demo-installation-trying-functionality-out)
- [Deployment options at a glance](planning.md#deployment-options-at-a-glance)
- [WIAB Dev (single-VM Wire-in-a-Box)](planning.md#wiab-dev-single-vm-wire-in-a-box)
- [WIAB Staging (multi-VM KVM-based test cluster)](planning.md#wiab-staging-multi-vm-kvm-based-test-cluster)
- [Production installation (persistent data, high-availability)](planning.md#production-installation-persistent-data-high-availability)
- [Capacity and scalability](planning.md#capacity-and-scalability)
- [Artifact bundle and offline deployment](planning.md#artifact-bundle-and-offline-deployment)
- [Next steps for high-available production installation](prod-intro.md#next-steps-for-high-available-production-installation)

## 2. Version Requirements
- [Version requirements](version-requirements.md)
Expand All @@ -13,59 +18,78 @@
- [Dependencies on operator’s machine](dependencies.md)
- [(Alternative) Installing dependencies using Direnv and Nix](dependencies.md#alternative-installing-dependencies-using-direnv-and-nix)

## 4. How to install Wire in a box (Demo)
- [Demo Wire-in-a-Box Deployment Guide](demo-wiab.md)
- [Introduction](demo-wiab.md#introduction)
- [What will be installed?](demo-wiab.md#what-will-be-installed)
- [Wire Demo installation diagram](demo-wiab.md#diagram)
- [Installation Guide](demo-wiab.md#installation-guide)
- [Deployment requirements](demo-wiab.md#deployment-requirements)
- [Getting Started](demo-wiab.md#getting-started)
- [Deployment Flow](demo-wiab.md#deployment-flow)
- [General Tips](demo-wiab.md#general-tips)
- [Trying Things Out](demo-wiab.md#trying-things-out)
- [Troubleshooting](demo-wiab.md#troubleshooting)
- [Cleaning/Uninstalling Wire-in-a-Box](demo-wiab.md#cleaninguninstalling-wire-in-a-box)

## 5. Introduction
## 4. How to install Wire in a box (Dev)
- [WIAB Dev (Wire-in-a-Box development) Deployment Guide](wiab-dev.md)
- [Introduction](wiab-dev.md#introduction)
- [What will be installed?](wiab-dev.md#what-will-be-installed)
- [Relation to WIAB Staging and Production](wiab-dev.md#relation-to-wiab-staging-and-production)
- [Architecture overview](wiab-dev.md#architecture-overview)
- [Deployment requirements](wiab-dev.md#deployment-requirements)
- [Getting Started](wiab-dev.md#getting-started)
- [Deployment Flow](wiab-dev.md#deployment-flow)
- [Ansible notes](wiab-dev.md#ansible-notes)
- [Troubleshooting](wiab-dev.md#troubleshooting)
- [Cleaning/Uninstalling Wire-in-a-Box](wiab-dev.md#cleaninguninstalling-wire-in-a-box)

## 5. How to install Wire in a box (Staging)
- [WIAB Staging Deployment Guide](wiab-staging.md)
- [Introduction](wiab-staging.md#introduction)
- [Architecture overview](wiab-staging.md#architecture-overview)
- [Relation to production](wiab-staging.md#relation-to-production)
- [Requirements](wiab-staging.md#requirements)
- [VM Provisioning](wiab-staging.md#vm-provisioning)
- [Getting the Ansible playbooks](wiab-staging.md#getting-the-ansible-playbooks)
- [When VMs are ready](wiab-staging.md#when-vms-are-ready)
- [Kubernetes & Data Services Deployment](wiab-staging.md#kubernetes-and-data-services-deployment)
- [Helm Operations to install Wire services and supporting Helm charts](wiab-staging.md#helm-operations-to-install-wire-services-and-supporting-helm-charts)
- [Network Traffic Configuration](wiab-staging.md#network-traffic-configuration)
- [cert-manager behaviour in NAT / bridge environments](wiab-staging.md#cert-manager-behaviour-in-nat-or-bridge-environments)
- [Next steps and troubleshooting](wiab-staging.md#next-steps-and-troubleshooting)

## 6. Introduction
- [Introduction](prod-intro.md)
- [What will be installed by following these parts?](prod-intro.md#what-will-be-installed-by-following-these-parts)
- [What will not be installed?](prod-intro.md#what-will-not-be-installed)
- [What will not be installed by default?](prod-intro.md#what-will-not-be-installed-by-default)
- [Getting support](prod-intro.md#getting-support)
- [Next steps for high-available production installation](prod-intro.md#next-steps-for-high-available-production-installation)

## 6. Installing Kubernetes and Databases
- [How to install kubernetes and databases](ansible-VMs.md)
## 7. Installing Kubernetes and Databases
- [Installing kubernetes and databases on VMs with ansible](ansible-VMs.md)
- [Introduction](ansible-VMs.md#introduction)
- [Assumptions](ansible-VMs.md#assumptions)
- [Preparing to run ansible](ansible-VMs.md#preparing-to-run-ansible)
- [Running ansible to install software on your machines](ansible-VMs.md#running-ansible-to-install-software-on-your-machines)
- [Downloading and extracting the artifact](ansible-VMs.md#downloading-and-extracting-the-artifact)
- [Editing the inventory](ansible-VMs.md#editing-the-inventory)
- [Generating secrets for the services](ansible-VMs.md#generating-secrets-for-the-services)
- [Deploying Kubernetes and stateful services](ansible-VMs.md#deploying-kubernetes-and-stateful-services)
- [Deploying secondary k8s cluster for calling services](ansible-VMs.md#deploying-secondary-k8s-cluster-for-calling-services)
- [Post Installation checks](ansible-VMs.md#post-installation-checks)
- [Next steps for high-available production installation](ansible-VMs.md#next-steps-for-high-available-production-installation)

## 7. Configuring AWS Services

## 8. Configuring AWS Services
- [How to configure AWS services](aws-prod.md)
- [Introduction](aws-prod.md#introduction)
- [Using real AWS services for SNS](aws-prod.md#using-real-aws-services-for-sns)
- [Using real AWS services for SES / SQS](aws-prod.md#using-real-aws-services-for-ses-sqs)
- [Using real AWS services for S3](aws-prod.md#using-real-aws-services-for-s3)

## 8. Installing Wire-Server using Helm
## 9. Installing Wire-Server using Helm
- [How to install wire-server using Helm](helm-prod.md)
- [Introduction](helm-prod.md#introduction)
- [Prerequisites](helm-prod.md#prerequisites)
- [Preparing to install charts from the internet with Helm](helm-prod.md#preparing-to-install-charts-from-the-internet-with-helm)
- [Watching changes as they happen](helm-prod.md#watching-changes-as-they-happen)
- [General installation notes](helm-prod.md#general-installation-notes)
- [How to install charts that provide access to external databases](helm-prod.md#how-to-install-charts-that-provide-access-to-external-databases)
- [Fake AWS (SNS/SQS) for websocket-only notifications (no FCM/APNS)](helm-prod.md##fake-aws-snssqs-for-websocket-only-notifications-no-fcmapns)
- [Fake AWS (SNS/SQS) for websocket-only notifications (no FCM/APNS)](helm-prod.md#fake-aws-snssqs-for-websocket-only-notifications-no-fcmapns-on-android-devices)
- [Preparing to install wire-server](helm-prod.md#preparing-to-install-wire-server)
- [How to install RabbitMQ](helm-prod.md#how-to-install-rabbitmq)
- [How to configure real SMTP (email) services](helm-prod.md#how-to-configure-real-smtp-email-services)
- [How to install fake SMTP (email) services](helm-prod.md#how-to-install-fake-smtp-email-services)
- [How to install wire-server itself](helm-prod.md#how-to-install-wire-server-itself)
- [DNS records](helm-prod.md#dns-records)

## 9. Multi-Ingress Configuration
## 10. Multi-Ingress Configuration
- [How to configure a Wire deployment for Multi-Ingress](multi-ingress.md)
- [What is a Multi-ingress setup?](multi-ingress.md#what-is-a-multi-ingress-setup)
- [How is multi-ingress useful?](multi-ingress.md#how-is-multi-ingress-useful)
Expand All @@ -77,7 +101,7 @@
- [Calling](multi-ingress.md#calling)
- [How to setup VPS for each domain between a client and wire-backend](multi-ingress.md#how-to-setup-vps-for-each-domain-between-a-client-and-wire-backend)

## 10. Infrastructure Configuration
## 11. Infrastructure Configuration
- [Infrastructure configuration](infrastructure-configuration.md)
- [Redirect some traffic through a http(s) proxy](infrastructure-configuration.md#redirect-some-traffic-through-a-http-s-proxy)
- [Enable push notifications using the public appstore / playstore mobile Wire clients](infrastructure-configuration.md#enable-push-notifications-using-the-public-appstore-playstore-mobile-wire-clients)
Expand All @@ -99,11 +123,11 @@
- [S3 Addressing Style](infrastructure-configuration.md#s3-addressing-style)
- [I have a team larger than 500 users](infrastructure-configuration.md#i-have-a-team-larger-than-500-users)

## 11. Monitoring Wire-Server
## 12. Monitoring Wire-Server
- [How to monitor wire-server](monitoring.md)
- [Dashboards](monitoring.md#dashboards)

## 12. Centralized Logs for Wire-Server
## 13. Centralized Logs for Wire-Server
- [How to see centralized logs for wire-server](logging.md)
- [Introduction](logging.md#introduction)
- [Status](logging.md#status)
Expand All @@ -115,28 +139,28 @@
- [Nuking it all.](logging.md#nuking-it-all)
- [Debugging](logging.md#debugging)

## 13. Ingress-Controller (Getting Traffic In)
## 14. Ingress-Controller (Getting Traffic In)
- [Ingress-controller (getting traffic in)](ingress.md)
- [Installing in a cloud-like environment](ingress.md#installing-in-a-cloud-like-environment)
- [Installing on bare-metal without dynamic load balancer support](ingress.md#installing-on-bare-metal-without-dynamic-load-balancer-support)

## 14. Web App Settings
## 15. Web App Settings
- [Web app settings](web-app-settings.md)
- [Enforce desktop application only](web-app-settings.md#enforce-desktop-application-only)
- [Enforce constant bit rate](web-app-settings.md#enforce-constant-bit-rate)
- [Disable media plugins](web-app-settings.md#disable-media-plugins)
- [Enable extra entropy (only on Windows)](web-app-settings.md#enable-extra-entropy-only-on-windows)

## 15. Installing Conference Calling 2.0 (aka SFT)
## 16. Installing Conference Calling 2.0 (aka SFT)
- [Installing Conference Calling 2.0 (aka SFT)](sft.md)
- [Background](sft.md#background)

## 16. Installing Restund
## 17. Installing Restund
- [Installing Restund](restund.md)
- [Background](restund.md#background)
- [Installation instructions](restund.md#installation-instructions)

## 17. Configure TLS Ciphers
## 18. Configure TLS Ciphers
- [Configure TLS ciphers](tls.md)
- [Ingress Traffic (wire-server)](tls.md#ingress-traffic-wire-server)
- [Egress Traffic (wire-server/federation)](tls.md#egress-traffic-wire-server-federation)
Expand All @@ -146,16 +170,16 @@
- [Restund (ansible)](tls.md#restund-ansible)
- [Restund (kubernetes)](tls.md#restund-kubernetes)

## 18. Managing Authentication with Ansible
## 19. Managing Authentication with Ansible
- [Managing authentication with ansible](ansible-authentication.md)
- [How to use password authentication when you ssh to a machine with ansible](ansible-authentication.md#how-to-use-password-authentication-when-you-ssh-to-a-machine-with-ansible)
- [Configuring SSH keys](ansible-authentication.md#configuring-ssh-keys)
- [Sudo without password](ansible-authentication.md#sudo-without-password)

## 19. Using Tinc
## 20. Using Tinc
- [Using tinc](ansible-tinc.md)

## 20. Troubleshooting During Installation
## 21. Troubleshooting During Installation
- [Troubleshooting during installation](troubleshooting.md)
- [Problems with CSP on the web based applications (webapp, team-settings, account-pages)](troubleshooting.md#problems-with-csp-on-the-web-based-applications-webapp-team-settings-account-pages)
- [Problems with ansible and python versions](troubleshooting.md#problems-with-ansible-and-python-versions)
Expand All @@ -167,10 +191,7 @@
- [Diagnosing issues with installation steps.](troubleshooting.md#diagnosing-issues-with-installation-steps)
- [Verifying correct deployment of DNS / DNS troubleshooting.](troubleshooting.md#verifying-correct-deployment-of-dns-dns-troubleshooting)

## 21. Verifying Your Installation
## 22. Verifying Your Installation
- [Verifying your installation](post-install.md)
- [NTP Checks](post-install.md#ntp-checks)
- [Logs and Data Protection checks](post-install.md#logs-and-data-protection-checks)
- [Demo installation (trying functionality out)](planning.md#demo-installation-trying-functionality-out)
- [Production installation (persistent data, high-availability)](planning.md#production-installation-persistent-data-high-availability)

Loading
Loading