About this project

Outline Apps is the repository for the Outline project's two core applications, which together make it possible for individuals to set up and share access to a VPN server. Outline Manager (in the server_manager directory) is a graphical user interface for managing Outline servers. It is distributed for Windows, macOS and Linux. Its purpose is to simplify the creation and administration of a VPN server, so that a user can share access with others in their network. Outline Client (in the client directory) is a cross-platform proxy client available for Windows, macOS, iOS, Android and Linux. It is designed to work with servers deployed through Outline Manager, but the README states it is also fully compatible with any Shadowsocks server. The README points to separate documentation in server_manager/README.md and client/README.md for further details, and to the project website for installation instructions for both the manager and the client. Community and support resources mentioned include a Reddit community (r/outlinevpn), a Mattermost community channel, a contributing guide, an AGENTS.md file with AI agent and developer guidance, and a support site for direct contact. The project also references Google's code style (gts). The repository is aimed at users who want to run their own VPN server and at developers interested in contributing to the client and manager applications.