How to connect Outline client to Outline server? How to generate access key?

[the-webb-identity]

I am using a Raspberry Pi + Ubuntu.

I have installed the outline server using:
https://github.com/OutlineFoundation/tunnel-server/releases/download/v1.9.2/outline-ss-server_1.9.2_linux_arm64.tar.gz

with config YAML:

---
web:
  servers:
    - id: "outline-ss-server"
      listen:
        - "0.0.0.0:4444"

services:
  - listeners:
      - type: "websocket-stream"
        web_server: "outline-ss-server"
        path: "/a1b2c3"
      - type: "websocket-packet"
        web_server: "outline-ss-server"
        path: "/d4e5f6"
    keys:
      - id: "1"
        cipher: "chacha20-ietf-poly1305"
        secret: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

the Outline client needs an access key to connect to this server

how do I generate an access key for the client? in the form ss://...

if I need to do additional steps other than the above, then what do I need to do specifically? please describe in great detail

[ohnorobo]

Hi @the-webb-identity I think you will find this tutorial (in russian, but machine translation works fine) very useful: https://codepoetry.ru/post/nastraivaiem/

Please let us know if you have questions while/after following that.

[the-webb-identity]

@ohnorobo thank you very much, this helped a lot!
but I have additional information that I would like to document to help others
where can I add a more comprehensive tutorial?

[ohnorobo]

A websockets setup tutorial would be really wonderful to have, thank you!

The best place would be to add an article to our developer documentation site here https://developer.getoutline.org/

Those articles are accessible to edit/add to at https://github.com/OutlineFoundation/developer-documentation, you can send change suggestions or new articles as a PR. (The CI will complain about translations, but don't worry about it. Feel free to just add things in English)

For a tutorial the best place would be to add a new section under docs/vpn/tutorials/[your-tutorial].md

[the-webb-identity]

@ohnorobo I have created this PR: OutlineFoundation/developer-documentation#3