Repository files navigation

This repository is part of the source code of Wire. You can find more information atwire.com or by contactingopensource@wire.com.

You can find the published source code atgithub.com/wireapp/wire.

For licensing information, see the attached LICENSE file and the list of third-party licenses atwire.com/legal/licenses/.

No license is granted to the Wire trademark and its associated logos, all of which will continue to be owned exclusively by Wire Swiss GmbH. Any use of the Wire trademark and/or its associated logos is expressly prohibited without the express prior written consent of Wire Swiss GmbH.

This repository contains the source code for the Wire server. It contains all libraries and services necessary to run Wire.

For documentation on how to self host your own Wire-Server seethis section. Federation is on our long term roadmap.

See more in "Open sourcing Wire server code".

This repository contains the following source code:

• services

  • nginz: Public API Reverse Proxy (Nginx with custom libzauth module)
  • galley: Conversations and Teams
  • brig: Accounts
  • gundeck: Push Notification Hub
  • cannon: WebSocket Push Notifications
  • cargohold: Asset (image, file, ...) Storage
  • proxy: 3rd Party API Integration
  • restund: STUN/TURN server for use in Audio/Video calls
  • spar: Single-Sign-On (SSO)

• tools

  • api-simulations: Run automated smoke and load tests
  • db/: Migration tools (e.g. when new tables are added)
  • stern/: Backoffice tool (basicSwagger based interface)

• libs: Shared libraries

It also contains

• build: Build scripts and Dockerfiles for some platforms
• deploy: (Work-in-progress) - how to run wire-server in an ephemeral, in-memory demo mode
• doc: Documentation
• hack: scripts and configuration for kuberentes helm chart development/releases mainly used by CI
• charts: Kubernetes Helm charts. The charts are mirroed to S3 and can be used withhelm repo add wire https://s3-eu-west-1.amazonaws.com/public.wire.com/charts. See theAdministrator's Guide for more info.

The following diagram gives a high-level outline of the (deployment) architectureof the components that make up a Wire Server as well as the main internal andexternal dependencies between components.

Communication between internal components is currently not guarded bydedicated authentication or encryption and is assumed to be confined to aprivate network.

There are two options:

If you don't wish to build all docker images from scratch (e.g. theubuntu20-builder takes a very long time), ready-built images can be downloaded fromhere.

If you wish to build your own docker images, you needdocker version >= 17.05 andmake. Then,

# optionally:# make docker-builder # if you don't run this, it pulls the ubuntu20-builder image from quay.iomake docker-deps docker-intermediate docker-services# subsequent times, after changing code, if you wish to re-create docker images, it's sufficient tomake docker-intermediate docker-services

will, eventually, have built a range of docker images. Make sure togive Docker enough RAM; if you seemake: *** [builder] Error 137, it might be a sign that the build ran out of memory. You can also mix and match – e.g. pull theubuntu20-builder image and build the rest locally.

See theMakefiles andDockerfiles, as well asbuild/ubuntu/README.md for details.

This is suitable only for local development and testing. Seebuild instructions in the developer documentation.

You have two options:

• Option 1. (recommended) Install wire-server on kubernetes using the configuration and instructions provided inwire-server-deploy. This is the best option to run it on a server and recommended if you want to self-host wire-server.

• Option 2. Compile everything in this repo, then you can use theservices/start-services-only.sh. This option is intended as a way to try out wire-server on your local development machine and not suited for production.