# Charmed 5G

Charmed 5G is a secure, reliable and observable open source 5G network.

Charmed 5G is built using [Open Networking Foundation](https://opennetworking.org/) projects:
- **Charmed SD-Core**: A charmed distribution of ONF's SD-Core. It is a 5G core network, responsible for the 5G Network's control operations: Authentication, IP assignment, Policy management, Quality of Service, Slice management, and more.
- **Charmed SD-RAN**: A charmed distribution of ONF's SD-RAN. It is a 5G Radio Access Network built on the Open RAN architecture.

Charmed 5G exists because mobile networks are traditionally costly and difficult to operate and that open source alternatives are either too complex or unsecure. The project combines ONF's 5G expertise with Juju model driven operations.

Charmed 5G is for private mobile networks operators and all connectivity enthusiasts. Use it in your farm, mine or oil rig, wherever you need 5G connectivity.

## In this documentation

````{grid} 1 1 2 2

```{grid-item-card}
:link: tutorials/

Tutorials
^^^

**Start here**: a hands-on introduction to Charmed 5G for new users
```

```{grid-item-card}
:link: how-to/

How-to guides
^^^

**Step-by-step guides** covering key operations and common tasks
```

````


````{grid} 1 1 2 2

```{grid-item-card}
:link: reference/

**Reference**
^^^

**Technical information** - specifications, APIs, architecture
```

```{grid-item-card}
:link: explanation/

Explanation
^^^

**Discussion and clarification** of key topics
```

````

## Project and community

Charmed 5G is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

- [Ubuntu Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct)
- [Open a bug](https://github.com/canonical/charmed-5g/issues)
- [Contribute](https://github.com/canonical/charmed-5g/)

```{toctree}
:hidden:

tutorials/index
how-to/index
reference/index
explanation/index
```