Proposal: Provide Official SDK or API for Integrating Outline Client into Custom Apps

[MahmoudMahami]

Hi Outline Team,

I’m Maham, founder of XRay Global, a VPN provider based in Iran. We run our own Outline servers and currently offer accounts to users through our own platform. We direct them to install the official Outline client, but we are now aiming to embed Outline's client functionality directly into our app to improve usability and remove friction — especially for users in countries with restrictive environments.

We propose that the Outline team consider developing and releasing an official SDK or embeddable API (for Android, iOS, and Windows), which allows third-party applications to establish Outline connections directly without requiring the standalone client app.

Reasons for Proposal:

• 🔒 Better user experience: Integration into a single app simplifies onboarding and improves privacy control for users.
• 🌍 Helps in censored environments: In countries like Iran, installing external apps is not always viable.
• 🧩 Reduces dependency: A modular SDK allows service providers like us to embed connection logic into their branded apps.
• ✅ Increases adoption: A clean integration pathway could accelerate the global spread of Outline-powered services.

Key Needs:

• Shadowsocks/Outline connection module with basic lifecycle management (connect/disconnect/status)
• Proper licensing and documentation for legal, white-label use
• Cross-platform compatibility or platform-specific SDKs (Android/iOS/Windows)

We would be happy to collaborate or provide testing feedback during the development of such SDKs.

Looking forward to your thoughts and support.

Best regards,
Maham
Founder & Manager – XRay Global

[fortuna]

I'm not sure I understand your request. The Outline SDK exists, you are literally creating a discussion in the Outline SDK repository! :-)

Several apps already embed our SDK, from content apps using our Mobile Proxy (DW, Balatarin, Noticias Sin Filtro, ...) to circumvention tools using our strategies (Lantern, nthlink, Psiphon).

Please take a look at our README and the documentation in https://developers.google.com/outline/docs/guides/sdk/what-is-the-sdk.