Documentation
A guide to setting up an organization in OSM and to joining as a member. The detailed manual comes with the first public version.
Ways to run
- Without your own server
- All data runs encrypted over public relays. No infrastructure of your own is needed; this way there is no voice.
- With your own service
- A compact service of the organization, for example with Docker on a NAS or a rented server, with its own relay and voice server (not yet connected to the app). It too never sees file contents in plain text.
Modules of the service
| Module | Description | Requirement |
|---|---|---|
ry | Relay: transports the encrypted data packets. | Required |
fw | TLS and certificates for access from outside. | Required once reachable from outside |
voice | Voice with its own TURN server (the server stands, the app is to follow). | Optional |
sec | Issues members with a valid badge their access to voice. | Only with voice |
cc | Takes over settings the leadership has signed. | Optional |
web | Serves static pages, nothing else. | Optional |
Each module runs under its own access and sees only what its task needs. The module update runs only at the update point of OSM, never at an organization. Docker with several containers is built; a single image and packages for Linux and Windows without Docker are planned.
Membership and joining
- The leadership shares the organization's seal, in the community's Discord for example, and gives its fingerprint by a second, independent way.
- The new member receives a personal joining code.
- With seal and code the member joins in the app, signs in once through Discord and receives a digital badge.