Skip to content

Update documentation of dependency setup #1900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
battermann merged 5 commits into from
Nov 12, 2021
Merged

Update documentation of dependency setup #1900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
440e577
added pcre packages (perl compatible regex needed for headroom)
battermann Nov 1, 2021
b1af9b8
put more emphasis on the stack version which should match the one on …
battermann Nov 1, 2021
b915c44
moved and updated nix and direnv instruction
battermann Nov 1, 2021
a7aaa4a
Update docs/developer/dependencies.md
Nov 12, 2021
0041d6e
added a note on building nginz
battermann Nov 12, 2021
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
44 changes: 34 additions & 10 deletions docs/developer/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,32 @@ In addition to the information below, you can also consult the Dockerfiles for A

## General package dependencies (needed to compile Haskell services)

*Note: all the below sections for getting compile-time dependencies necessary to compile all of wire-server may potentially go out of date; if you spot a mistake please open an issue or PR*

### Nix + Direnv

Using Stack's [Nix integration](https://docs.haskellstack.org/en/stable/nix_integration/), Stack will take care of installing any system
Copy link
Member

@jschaul jschaul Nov 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a note should be added that this needs to be enabled manually by passing the --nix flag to stack or set a config in stack.yaml locally. Maybe someone for whom the nix+stack setup works out of the box could add a sentence or two here.

dependencies automatically - including `cryptobox-c`. If new system dependencies are needed, add them to the `stack-deps.nix` file in the project root.

If you have `direnv` and `nix`, you will automatically have `make`, `docker-compose` and `stack` in `PATH` once you `cd` into the project root and `direnv allow`.
You can then run all the builds, and the native dependencies will be automatically present.

1. Install [Nix](https://nixos.org/download.html)
* MacOS users with a recent Mac might need to follow [these
instructions](https://nixos.org/nix/manual/#sect-macos-installation)
* Debian users can use their distro's `nix` package, and should remember

to add their user to the `nix-users` group in /etc/group, and re-start
their login session.
2. Install [Direnv](https://direnv.net/).
* On debian, you can install the `direnv` package. On MacOS use `brew install direnv`.
* On NixOS with home-manager, you can set `programs.direnv.enable = true;`.
* Make sure direnv is hooked into your shell via it's appripriate `rc` file.
Add `eval "$(direnv hook bash|zsh|fish)"` to your ~/.(bash|zsh|fish)rc .
* When successfully installed and hooked, direnv should ask you to `direnv allow`
the current `.envrc` when you cd to this repository.
See the [Installation documentation](https://direnv.net/docs/installation.html) for further details.

### Fedora:

```bash
Expand All @@ -22,7 +48,7 @@ sudo dnf install -y pkgconfig haskell-platform libstdc++-devel libstdc++-static
_Note_: Debian is not recommended due to this issue when running local integration tests: [#327](https://github.com/wireapp/wire-server/issues/327). This issue does not occur with Ubuntu.

```bash
sudo apt install pkg-config libsodium-dev openssl-dev libtool automake build-essential libicu-dev libsnappy-dev libgeoip-dev protobuf-compiler libxml2-dev zlib1g-dev libtinfo-dev liblzma-dev -y
sudo apt install pkg-config libsodium-dev openssl-dev libtool automake build-essential libicu-dev libsnappy-dev libgeoip-dev protobuf-compiler libxml2-dev zlib1g-dev libtinfo-dev liblzma-dev libpcre3 libpcre3-dev -y
```

If `openssl-dev` does not work for you, try `libssl-dev`.
Expand Down Expand Up @@ -63,7 +89,13 @@ sudo installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_heade

Please refer to [Stack's installation instructions](https://docs.haskellstack.org/en/stable/README/#how-to-install).

When you're done, ensure `stack --version` is recent, ideally the same as `STACK_ALPINE_VERSION` in [`build/alpine/Dockerfile.prebuilder`](../../build/alpine/Dockerfile.prebuilder).
When you're done, ensure `stack --version` is the same as `STACK_ALPINE_VERSION` in [`build/alpine/Dockerfile.prebuilder`](../../build/alpine/Dockerfile.prebuilder).

If you have to, you can downgrade stack with this command:

```bash
stack upgrade --binary-version <version>
```

### Ubuntu / Debian
_Note_: The packaged versions of `haskell-stack` are too old. It is recommended to follow the generic instructions or to use stack to update stack (`stack upgrade`).
Expand Down Expand Up @@ -174,14 +206,6 @@ docker login --username=<MY_DOCKER_USERNAME>
* [Install docker](https://docker.com)
* [Install docker-compose](https://docs.docker.com/compose/install/)

## Nix + Direnv

Using Stack's [Nix integration](https://docs.haskellstack.org/en/stable/nix_integration/), Stack will take care of installing any system
dependencies automatically - including `cryptobox-c`. If new system dependencies are needed, add them to the `stack-deps.nix` file in the project root.

If you have `direnv` and `nix`, you will automatically have `make`, `docker-compose` and `stack` in `PATH` once you `cd` into the project root and `direnv allow`.
You can then run all the builds, and the native dependencies will be automatically present.

## Telepresence

You can instead use [telepresence](https://www.telepresence.io) to allow you to talk to services installed in a given kubernetes namespace on a local or remote kubernetes cluster using easy DNS names like: `curl http://elasticsearch:9200`.
Expand Down
1 change: 1 addition & 0 deletions docs/developer/how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Terminal 1:

Terminal 2:
* Compile all services: `make services`
* Note that you have to [import the public signing keys for nginx](../../services/nginz/README.md#common-problems-while-compiling) to be able to build nginz
* Run services including nginz: `export INTEGRATION_USE_NGINZ=1; ./services/start-services-only.sh`

Open your browser at:
Expand Down
2 changes: 1 addition & 1 deletion tools/nginz_disco/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

Due to nginx not supporting DNS names for its list of upstream servers (unless you pay extra), the nginz-disco container is a simple bash script to do DNS lookups and write the resulting IPs to a file. Nginz reloads on changes to this file.

This is useful as a sidecar container to nginz in kubernetes. See also [wire-server-deploy/nginz](https://github.com/wireapp/wire-server-deploy/charts/nginz/)
This is useful as a sidecar container to nginz in kubernetes. See also [wire-server-deploy/nginz](https://github.com/wireapp/wire-server-deploy/charts/nginz/) <!-- todo: this link is broken >
Copy link
Member

@jschaul jschaul Nov 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this chart has been merged into wire-server, so the reference should be ./charts/nginz/