<commit_before># autovpn

## Description
Monitor a user's `Downloads` folder for VPN config files and automatically use them to connect to a VPN.

## Installation
There is an installation script `install.sh` provided which should work for Ubuntu (and derivatives), and will hopefully give any other curious folk an idea of the manual steps required.
To run the installation script enter the following into a terminal:
```bash
curl -s 'https://raw.githubusercontent.com/RobinKnipe/autovpn/master/install.sh' | sudo bash -s $HOME
```
You can check everything worked with `sudo systemctl list-dependencies` - you should see something like the following example - note the `autovpn.service` unit is listed as the second item under the `default.target` (the dot next to it should _hopefully_ be green):
```bash
sudo systemctl list-dependencies
default.target
● ├─accounts-daemon.service
● ├─autovpn.service
...
```

## Configuration
When the service starts, it looks for a file `${HOME}/.config/autovpn.properties`. This file contains a few options to tailor the script:

### Download folder location
By default the monitored folder is: `"${HOME}/Downloads"`. To change it, add the `download_dir` property, as in the following example:
```properties
# look in "/tmp/downloads" instead
download_dir=/tmp/downloads
```
<commit_msg>Update the install process documentation<commit_after># autovpn

## Description
Monitor a user's `Downloads` folder for VPN config files and automatically use them to connect to a VPN.

## Installation
There is an installation script `install.sh` provided which should work for Ubuntu (and derivatives), and will hopefully give any other curious folk an idea of the manual steps required.
To run the installation script (for the default user) enter the following into a terminal:
```bash
curl -s 'https://raw.githubusercontent.com/RobinKnipe/autovpn/master/install.sh' | sudo bash -s
```
You can check everything worked with `sudo systemctl list-dependencies` - you should see something like the following example - note the `autovpn.service` unit is listed as the second item under the `default.target` (the dot next to it should _hopefully_ be green):
```bash
sudo systemctl list-dependencies
default.target
● ├─accounts-daemon.service
● ├─autovpn.service
...
```
### NOTE:
If the install script fails, because it can't locate the user's home directory - or if support for another user (i.e. not the default) is required - the installation script can be run specifying the target home directory as follows:
```bash
curl -s 'https://raw.githubusercontent.com/RobinKnipe/autovpn/master/install.sh' | sudo bash -s $HOME
```

## Configuration
When the service starts, it looks for a file `${HOME}/.config/autovpn.properties`. This file contains a few options to tailor the script:

### Download folder location
By default the monitored folder is: `"${HOME}/Downloads"`. To change it, add the `download_dir` property, as in the following example:
```properties
# look in "/tmp/downloads" instead
download_dir=/tmp/downloads
```

{'fraction_non_alphanumeric': 0.09216136438176452, 'fraction_numerical': 0.0, 'mean_word_length': 4.899419729206963, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 14, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6027866', 'n_tokens_mistral': 861, 'n_tokens_neox': 796, 'n_words': 388}