Skip to content

Commit

Permalink
enable wg mode on windows
Browse files Browse the repository at this point in the history
  • Loading branch information
doums committed Dec 6, 2024
1 parent 8e29514 commit 89d3fbc
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions nym-vpn-app/docs/update_flatpak.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,49 @@

A new app **stable** release has been released and published

### How to update the Flatpak package
### Update the app metainfo

The app metainfo file is located at `.pkg/flatpak/net.nymtech.NymVPN.metainfo.xml`. \
Add a new `release` tag with the corresponding release info. \
Create a PR and merge into `develop`.

```xml
<releases>
<release version="1.2.3" date="2024-01-30">
<url type="details">
https://github.com/nymtech/nym-vpn-client/releases/tag/nym-vpn-app-v1.2.3
</url>
</release>
<!-- other releases -->
</releases>
```

### Update flatpak manifest

The package is hosted on [Flathub](https://flathub.org/apps/net.nymtech.NymVPN). \
The package repository is https://github.com/flathub/net.nymtech.NymVPN

Steps to update the package:

1. create a new branch from `master`
2. update the app manifest `net.nymtech.NymVPN.yml` accordingly to the new release

Most of the time it's needed to update the `url` and `sha256` fields \
of the app binary to point to the new release tag
2. update the app manifest `net.nymtech.NymVPN.yml`

At the very least you need to update the `url` and `sha256` fields \
of the binary and the metainfo, to point to the new release.

```yaml
sources:
- type: file
# update the release tag and version
url: https://github.com/nymtech/nym-vpn-client/releases/download/nym-vpn-app-v1.2.3/nym-vpn_1.2.3_linux_x64
sha256: xxxx # update the hash accordingly
only-arches: [x86_64]
dest-filename: nym-vpn
- type: file
# update the git hash to point to the new metainfo revision
url: https://raw.githubusercontent.com/nymtech/nym-vpn-client/abcdef12/nym-vpn-app/.pkg/flatpak/net.nymtech.NymVPN.metainfo.xml
sha256: xxxx # update the hash accordingly
```
3. submit the PR
4. a bot will trigger a build, if it is successful, check the package locally \
Expand Down

0 comments on commit 89d3fbc

Please sign in to comment.