Skip to content
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.

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

Reworked bash script #11

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 3 additions & 5 deletions README.bash
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Intro

This is a simple script that generates wireguard client config files for
surfshark

Expand All @@ -18,7 +17,6 @@ be generated.
3. run `gen_wg_config.bash`

## usage

```bash shell
Usage: gen_wg_config.bash [-h]
-g ignore generating profile files
Expand All @@ -35,7 +33,7 @@ Use the script at your own risk :).
We are not responsable if anything goes wrong

## First time running script
You may need to run script a few timed with no parameters if you have never run
You may need to run script a few times with no parameters if you have never run
script before. This is to make sure all needed files are created and your keys
are registered.
If you keep getting registeration errors, wait a bit (no idea how long) and try
Expand All @@ -44,7 +42,7 @@ later it eventually will work.
## Your private/public key expires
The token will last around 7 days so it needs to be regenerated before then.
I run the script with no parameters every 6 days.
It's also recommendef that a cron job is set to run every day during a known
It's also recommended that a cron job is set to run every day during a known
slack period with -n flag to keep your keys refreshed

## The server list changes every so often and the load changes fairly often.
Expand All @@ -56,7 +54,7 @@ You can do this by runnimg with -r option to regenerate server list.
If you are not able to use the generated config files, there might be a chance that there is an
unhandled corner case in one of the functions. Check that wg.json and token.json files have been
generated. Review the output, this should show where the script failed. Output is logged to
sswg.log in the same folder as the script.
sswg.log in the same folder as the config_folder.

# TODO
- fold in any updates done by kyndair :).
Expand Down
Loading