From 175559fd24dec2b85997c7b475b5c60f8dce5e26 Mon Sep 17 00:00:00 2001 From: Victor Date: Mon, 21 Oct 2024 01:11:43 +0100 Subject: [PATCH] docs: update license application, closes #425 --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d7c3f0a..0d864ca 100644 --- a/README.md +++ b/README.md @@ -36,25 +36,26 @@ The WireGuard profile will be saved under `wgcf-profile.conf`. For more informat #### Maximum transmission unit (MTU) To ensure maximum compatibility, the generated profile will have a MTU of 1280, just like the official Android app. If you are experiencing performance issues, you may be able to improve your speed by increasing this value. For more information, please check [#40](https://github.com/ViRb3/wgcf/issues/40). -### Change license key -If you have an existing Warp+ subscription, for an example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a current limit of maximum 5 linked devices active at a time. - -> :warning: This device's private key will be changed! +### Add a license key +If you have an existing Warp+ subscription, for example on your phone, you can bind the account generated by this tool to your phone's account, sharing its Warp+ status. Please note that there is a current limit of maximum of 5 linked devices active at a time. First, get your Warp+ account license key. To view it on Android: 1. Open the `1.1.1.1` app -2. Click on the hamburger menu button on the top-right corner +2. Click on the hamburger menu button on the top-right corner 3. Navigate to: `Account` > `Key` -Edit `wgcf-account.toml` directly with the new license key and run: +Now, back to wgcf. + +> :warning: If you have an existing account, you will need to delete it and create a new one ([!355](https://github.com/ViRb3/wgcf/pull/355), [!425](https://github.com/ViRb3/wgcf/pull/425)): +> ```wgcf register +> wgcf register +> ``` +Then, immediately add your key to `wgcf-account.toml`. Finally, run: + ```bash wgcf update +wgcf generate ``` -or, using an environment variable: -```bash -WGCF_LICENSE_KEY="123412341234" wgcf update -``` -The license will be applied, and a new private key will be created for your account. [Regenerate](#generate-wireguard-profile) your WireGuard configuration and use the new private key. ### Check device status