MCPcopy Index your code
hub / github.com/runtipi/runtipi

github.com/runtipi/runtipi @v4.10.1 sqlite

repository ↗ · DeepWiki ↗ · release v4.10.1 ↗
1,571 symbols 4,385 edges 432 files 75 documented · 5%
README

Runtipi — A personal homeserver for everyone

All Contributors

License Version Issues Build Crowdin Gurubase

[!NOTE] Runtipi is built with TypeScript, NestJS and React! If you want to collaborate on a cool project, join the discussion in the forums or on Discord!

Join the community

Forums Discord

Preview

[!WARNING]
Runtipi is built and maintained by volunteers. There is no guarantee of support or security when you use Runtipi. While the system is considered stable, it is still in active development and may contain bugs.

Runtipi is a personal homeserver orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Runtipi is designed to be easy to use, so you don't have to worry about manual configuration or networking. Simply install Runtipi on your server and use the web interface to add and manage services. You can see a list of available services in the App Store repo and if you can't find what you're looking for, there are many community app stores to choose from and you can even create your own. To get started with Runtipi, follow the installation instructions below.

Sponsors

Thanks to our generous sponsors for supporting the development of Runtipi:

CodeRabbit TestMu AI
CodeRabbit logo
coderabbit.ai Browser testing via testmu.ai

Getting started

Visit our website runtipi.io for installation instructions, documentation and guides. If you need more personalized help, visit our Forums to get help from the community.

Demo

You can try out a demo of Runtipi at demo.runtipi.io using the following credentials:

username: user@runtipi.io
password: password

📚 Documentation

You can find more documentation and tutorials / FAQ on runtipi.io

❤ Contributing

Runtipi is made to be very easy to plug in new apps. We welcome and appreciate new contributions.

If you want to add a new app or feature, you can follow the Contribution guide for instructions on how to do so.

We are looking for contributions of all kinds. If you know design, development, or have ideas for new features, please get in touch.

📜 License

License

Runtipi is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

🗣 Community

🙏 Acknowledgements

  • GitHub - Thanks for generously giving us access to your full product suite
  • OpenAI - Thanks for providing free access to codex and security tools for the project
  • Freepik - Thanks for providing a free logo for the project
  • Sentry - Thanks for providing error tracking for the project
  • Crowdin - Thanks for providing localization management for the project
  • CodeRabbit - Thanks for providing free AI code reviews in our Pull Requests

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Nicolas Meienberger Nicolas Meienberger 💻 🚇 ⚠️ 📖 ArneNaessens ArneNaessens 💻 🤔 ⚠️ DrMxrcy DrMxrcy 💻 🤔 ⚠️ 🖋 📣 💬 👀 Cooper Cooper 💻 JTruj1ll0923 JTruj1ll0923 💻 Stetsed Stetsed 💻 Jones_Town Jones_Town 💻
Rushi Chaudhari Rushi Chaudhari 💻 Robert Blaine Robert Blaine 💻 Seth For Privacy Seth For Privacy 💻 Prajna Prajna 💻 Justin Moy Justin Moy 💻 dextreem dextreem 💻 Brahim Hadriche Brahim Hadriche 💻
Andrew Brereton Andrew Brereton 🖋 Freddie Sackur Freddie Sackur 💻 📖 Innocentius Innocentius 🌍 Alex Alex 💻 Ryan Wang Ryan Wang 💻 simonandr simonandr 🖋 iepure iepure 🌍
Sergey Kodolov Sergey Kodolov 🌍 💻

Extension points exported contracts — how you extend this code

ILifecycleHandler (Interface)
(no doc) [23 implementers]
packages/backend/src/modules/app-lifecycle/handlers/base-handler.ts
IProps (Interface)
(no doc)
packages/frontend/src/modules/auth/components/login-form.tsx
Request (Interface)
(no doc)
packages/backend/src/types/express/index.d.ts
IProps (Interface)
(no doc)
packages/frontend/src/modules/auth/components/register-form.tsx
TraefikLabelsArgs (Interface)
(no doc)
packages/backend/src/modules/docker/builders/traefik-labels.builder.ts
ColorSelectorProps (Interface)
(no doc)
packages/frontend/src/modules/settings/components/color-selector/color-selector.tsx
Request (Interface)
(no doc)
packages/backend/src/@types/express/index.d.ts
IProps (Interface)
(no doc)
packages/frontend/src/modules/settings/components/user-settings-form/user-settings-form.tsx

Core symbols most depended-on inside this repo

get
called by 265
packages/backend/src/core/cache/cache.service.ts
set
called by 135
packages/backend/src/core/cache/cache.service.ts
getAppByUrn
called by 68
packages/backend/src/modules/apps/apps.repository.ts
configure
called by 53
packages/backend/src/app.module.ts
register
called by 49
packages/frontend/src/api-client/sdk.gen.ts
castAppUrn
called by 38
packages/backend/src/common/helpers/app-helpers.ts
validateAppUrn
called by 34
packages/backend/src/common/helpers/app-helpers.ts
close
called by 33
packages/backend/src/modules/queue/event.publisher.ts

Shape

Function 652
Method 470
Class 384
Interface 65

Languages

TypeScript100%

Modules by API surface

packages/frontend/src/api-client/@tanstack/react-query.gen.ts113 symbols
packages/frontend/src/api-client/sdk.gen.ts81 symbols
packages/backend/src/modules/auth/dto/auth.dto.ts30 symbols
packages/backend/src/modules/auth/auth.controller.ts26 symbols
packages/backend/src/modules/marketplace/dto/marketplace.dto.ts24 symbols
packages/backend/src/core/filesystem/filesystem.service.ts24 symbols
packages/backend/src/modules/marketplace/marketplace.service.ts21 symbols
packages/frontend/src/api-client/client/utils.gen.ts20 symbols
packages/backend/src/modules/app-lifecycle/app-lifecycle.service.ts20 symbols
packages/backend/src/modules/app-stores/app-store-files-manager.ts19 symbols
packages/backend/src/modules/apps/app-files-manager.ts18 symbols
packages/backend/src/modules/backups/backup.manager.ts16 symbols

Dependencies from manifests, versioned

@arethetypeswrong/cli0.18.1 · 1×
@biomejs/biome2.0.4 · 1×
@changesets/cli2.29.3 · 1×
@codemirror/lang-json6.0.2 · 1×
@codemirror/lang-markdown6.4.0 · 1×
@codemirror/lang-yaml6.1.2 · 1×
@codemirror/merge6.10.2 · 1×
@faker-js/faker10.1.0 · 1×
@hey-api/client-fetch0.13.1 · 1×
@hey-api/openapi-ts0.87.1 · 1×
@hookform/resolvers5.0.1 · 1×
@nestjs/cli11.0.7 · 1×

Datastores touched

tipiDatabase · 1 repos

For agents

$ claude mcp add runtipi \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact