README.template.md

OVPN-Configs-scraper

OVPN-Configs-scraper is a Node.js tool that automatically collects free OpenVPN configuration files from various public sources. It streamlines the retrieval, organization, and updating of these configs for quick use.

Features

• Automated scraping of public VPN server lists.
• Generation of ready-to-use .ovpn files.
• IP address caching and duplicate management.
• Export of configurations to a dedicated folder.

Important

To deploy your own version, you can use the following section. PLEASE DO NOT FORK, OUR VERSIONS WILL DIFFER ANYWAYS.

Prerequisites

• Node.js >= 20
• npm

Installation

git clone https://github.com/your-username/OVPN-Configs-scraper.git
cd OVPN-Configs-scraper
npm install

Build

Before running the app, you need to build the TypeScript source files:

npm run build

This will compile the TypeScript code into JavaScript in the dist/ directory.

Usage

To run the scraper and update the configuration files:

npm start

Tip

The generated .ovpn files can be found in the data/configs/ folder.

Download VPN Configurations

You can directly download the generated configuration files:

• Go to the configs/ folder

Or download individually:

{{ % table % }}

Tip: For the full list, check the data/configs/ folder after running the scraper.

Contributing

Contributions are welcome! Feel free to open an issue or a pull request.

License

MIT