diff options
| author | Linus Färnstrand <linus@mullvad.net> | 2018-05-08 17:04:58 +0200 |
|---|---|---|
| committer | Linus Färnstrand <linus@mullvad.net> | 2018-05-21 13:22:34 +0200 |
| commit | 0189ddab7ecd14c7e932c27118dce1bc551c504a (patch) | |
| tree | c3c2f3c26daa90ed74263c175f4f6933ffe29c88 | |
| parent | 1f00b320d10e8c486aa9766035fdf6443c0fa406 (diff) | |
| download | mullvadvpn-0189ddab7ecd14c7e932c27118dce1bc551c504a.tar.xz mullvadvpn-0189ddab7ecd14c7e932c27118dce1bc551c504a.zip | |
Add a paths section to README
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
@@ -227,6 +227,56 @@ Explanations for some common words used in the documentation and code in this re VPN app. +## File paths used by Mullvad VPN app + +A list of file paths written to and read from by the various components of the Mullvad VPN app + +### Daemon + +On Windows, when a process runs as a system service the variable `%APPDATA%` expands to +`C:\Windows\system32\config\systemprofile\AppData\Roaming`. + +#### Settings + +The directory and full path to the settings file is defined in `mullvad-daemon/src/settings.rs` + +| Platform | Path | +|----------|------| +| Linux | `/etc/mullvad-daemon/settings.json` | +| macOS | `/etc/mullvad-daemon/settings.json` | +| Windows | `%APPDATA%\Mullvad\Mullvad VPN\settings.json` + +#### Logs + +| Platform | Path | Defined in | +|----------|------|------------| +| Linux | `/var/log/mullvad-daemon/` + systemd | `linux/mullvad-daemon.service` | +| macOS | `/var/log/mullvad-daemon/` | `dist-assets/pkg-scripts/postinstall` | +| Windows | `C:\ProgramData\Mullvad VPN\` | `mullvad-daemon/src/system_service.rs` | + +The log directories are also defined in the `problem-report` source code. + +#### Cache + +The daemon caches relay server list and DNS lookups etc. The path to the cache dir is defined in +`mullvad-daemon/src/cache.rs` + +| Platform | Path | +|----------|------| +| Linux | `/var/cache/mullvad-daemon/` | +| macOS | `/var/root/Library/Caches/mullvad-daemon/` | +| Windows | `%APPDATA%\Local\Mullvad\Mullvad VPN\` | + +#### RPC address file + +The path to the RPC address file is defined in `mullvad-ipc-client/src/lib.rs` + +| Platform | Path | +|----------|------| +| Linux | `/tmp/.mullvad_rpc_address` | +| macOS | `/tmp/.mullvad_rpc_address` | +| Windows | `C:\ProgramData\Mullvad VPN\.mullvad_rpc_address` | + ## Quirks - If you want to modify babel-configurations please note that `BABEL_ENV=development` must be used |