73 lines
2.3 KiB
Plaintext
73 lines
2.3 KiB
Plaintext
---
|
|
title: Homarr documentation
|
|
description: Install, configure, operate, and extend Homarr.
|
|
---
|
|
|
|
import {
|
|
IconApi,
|
|
IconArrowUp,
|
|
IconBuildingStore,
|
|
IconChecklist,
|
|
IconCode,
|
|
IconComponents,
|
|
IconDownload,
|
|
IconLayoutDashboard,
|
|
IconPlugConnected,
|
|
IconSettings,
|
|
IconUsers,
|
|
IconVocabulary,
|
|
} from "@tabler/icons-react";
|
|
|
|
Use these guides to get Homarr running, connect your services, build useful boards, and manage an installation over time.
|
|
|
|
## Install or upgrade
|
|
|
|
<Cards>
|
|
<Card icon={<IconDownload />} title="Install Homarr" href="/docs/getting-started/installation">
|
|
Choose the installation method for your system.
|
|
</Card>
|
|
<Card icon={<IconArrowUp />} title="Upgrade from v1" href="/docs/getting-started/upgrade-v2">
|
|
Move an existing Homarr installation to v2.
|
|
</Card>
|
|
<Card icon={<IconChecklist />} title="Finish setup" href="/docs/getting-started/after-the-installation">
|
|
Add apps, integrations, and widgets after installation.
|
|
</Card>
|
|
<Card icon={<IconVocabulary />} title="Learn the concepts" href="/docs/getting-started">
|
|
Understand boards, apps, integrations, and widgets.
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Configure Homarr
|
|
|
|
<Cards>
|
|
<Card icon={<IconLayoutDashboard />} title="Boards and content" href="/docs/management">
|
|
Configure boards, apps, users, settings, and administration.
|
|
</Card>
|
|
<Card icon={<IconPlugConnected />} title="Connect services" href="/docs/integrations">
|
|
Find the setup guide for an integration.
|
|
</Card>
|
|
<Card icon={<IconComponents />} title="Choose widgets" href="/docs/widgets">
|
|
Find the content and controls available for boards.
|
|
</Card>
|
|
<Card icon={<IconSettings />} title="Advanced configuration" href="/docs/advanced">
|
|
Configure deployment, authentication, networking, and automation.
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Extend and contribute
|
|
|
|
<Cards>
|
|
<Card icon={<IconCode />} title="Custom Widgets" href="/docs/management/custom-widgets">
|
|
Author and publish Custom JSX widgets.
|
|
</Card>
|
|
<Card icon={<IconBuildingStore />} title="Community Workshop" href="/docs/workshop">
|
|
Use and operate the community extension registry.
|
|
</Card>
|
|
<Card icon={<IconApi />} title="API reference" href="/api-reference">
|
|
Inspect Homarr's HTTP API.
|
|
</Card>
|
|
<Card icon={<IconUsers />} title="Get help and contribute" href="/docs/community">
|
|
Find support and ways to contribute.
|
|
</Card>
|
|
</Cards>
|