https://github.com/magenta-aps/os2mo
Docs: https://rammearkitektur.docs.magenta.dk/os2mo/
https://github.com/magenta-aps/os2mo
managed-by-atlantis mirrored-repository
Last synced: 4 months ago
JSON representation
Docs: https://rammearkitektur.docs.magenta.dk/os2mo/
- Host: GitHub
- URL: https://github.com/magenta-aps/os2mo
- Owner: magenta-aps
- License: other
- Created: 2024-08-23T11:52:21.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:06:25.000Z (8 months ago)
- Last Synced: 2024-10-29T15:56:34.801Z (8 months ago)
- Topics: managed-by-atlantis, mirrored-repository
- Language: Python
- Homepage:
- Size: 60.1 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
# OS2mo
MO is an IT system for organisational and identity management.
It enables your organisation to maintain information about the organisation and
its employees, volunteers, external consultants, robot users, and so on, from a
single user interface.
You get a complete overview of all departments, employees' (multiple)
employments, their IT access, their affiliations, and roles throughout the
organisation. You also get a complete picture of management hierarchies, and
you can see your union representative organisation, your payroll organisation,
your safety organisation, your line organisation, etc.
The vision for MO is that it should be *the* source system for the entire
organisation and its employees: this is where organisational changes are made,
this is where employees are created and removed, and this information will
automatically - and immediately - be sent to other systems. The information can
also come from other systems - or be enriched from them - but it is MO that
contains the complete picture of the organisation.
Because MO contains all the information about the organisation, and it is always
up-to-date and correct, it is important to connect MO to other systems that
need the information - be it LDAP (e.g. Active Directory), an IdM system,
FK-Organisation, an org chart, an HR system, etc.
When MO is connected to many systems, workflows are automated and consistent
and high data quality is realised in the connected systems.
The primary documentation for OS2mo is available at
(in Danish).
Technical documentation in English is available at
.
## GraphQL
The primary API for OS2mo is GraphQL. The interface is versioned to handle
future breaking changes, without actually breaking any integration code. New
versions are added as needed and old versions are removed as they become
obsolete.
New integrations should always use the newest version of the interface
available, and old integrations should continuously be updated to the newer
versions as they are introduced, by following the [Migration
Guide](https://rammearkitektur.docs.magenta.dk/os2mo/tech-docs/graphql/migration.html).
The `/graphql` endpoint redirects the browser to the GraphiQL interface for the
newest version, e.g. for local development: .
GraphiQL has a built-in documentation explorer which can be accessed by
ctrl-clicking most fields.
There is no way to use the newest version of the GraphQL interface
programmatically, e.g. from integrations. This is by design to avoid
integrations being broken automatically once a new version is introduced, as
such, all integrations should be hardcoding the GraphQL version that they are
utilising and should update this hardcoded URL as they upgrade to a newer
version following the migration guide.
The GraphQL schema for each version is available at
`/graphql/vXX/schema.graphql` in regular GraphQL Schema Definition Language
(SDL).
More thorough documentation for the GraphQL API is available at
.
## Getting Started
To get a local OS2mo stack running on a sane operating system:
```shell
git clone https://github.com/OS2mo/os2mo.git
cd os2mo/
docker compose up -d --build
```
The OS2mo frontend should now be available at , and the
GraphiQL explorer at . The default admin
username/password is `alvida`/`alvida`.
To stop the stack, run
```shell
docker compose down
```
To stop the stack _and delete all data volumes_, run
```shell
docker compose down -v
```
A more detailed walk-through is available at
.
## Versioning
This project uses [Semantic Versioning](https://semver.org/) with the following
strategy:
- MAJOR: Incompatible API changes.
- MINOR: Backwards-compatible updates and functionality.
- PATCH: Backwards-compatible bug fixes.
The changelog is available at
.
## Authors
Magenta ApS
## License
[MPL-2.0](LICENSES/MPL-2.0.txt). This project uses
[REUSE](https://reuse.software) for licensing. All licenses can be found in the
[LICENSES folder](LICENSES/) of the project.