Skip to content

A self-hosted media server and file management system

6.5 KB
Raw Blame
<script setup lang="ts">
import { getSetupStatus } from '@/service/mediaAPI';
import { onMounted, ref } from 'vue';
import { useAuthStore } from '@/stores/AuthStore';
import { useAppStore } from '@/stores/AppStore';
import { storeToRefs } from 'pinia';

import LayoutBase from '@/layouts/LayoutBase.vue';

import ProiconsLibrary from '~icons/proicons/library';
import LucideFolder from '~icons/lucide/folder';

const { pageTitle, selectedSideBar } = storeToRefs(useAppStore());
const { userData } = storeToRefs(useAuthStore());

const setupData = ref<{
    has_data: boolean;
    library_count: number;
    folder_count: number;
    media_count: number;
    default_library?: {
        id?: string;
        name?: string;
    };
}>();

onMounted(async () => {
    pageTitle.value = 'MediaServer Setup';
    selectedSideBar.value = '';

    const { data } = await getSetupStatus();

    setupData.value = data;
});
</script>

<template>
    <LayoutBase>
        <template v-slot:content>
            <section id="content-settings" class="page-height flex flex-col gap-4 space-y-2 *:space-y-1">
                <h2>Before you can start watching, you must complete these setup steps</h2>
                <ul class="flex flex-col gap-2 text-sm">
                    <li class="flex flex-wrap items-center gap-1">
                        <p>
                            1. <RouterLink to="/register" :class="`text-primary-muted underline decoration-1`">Register</RouterLink> for an account. The first one will be your
                            administrator account.
                        </p>
                        <p v-show="userData" class="text-success ms-auto text-xs font-bold dark:text-green-700">Done!</p>
                    </li>
                    <li>
                        <span class="flex items-start gap-1">
                            <p>2. Put your files in the data/media folder. You must follow this folder structure. An example url would be /library1/folder2</p>
                            <p v-show="setupData?.has_data" class="text-success ms-auto text-xs font-bold dark:text-green-700">Done!</p>
                        </span>
                        <div class="w-full p-2 font-mono">
                            <ul>
                                <li class="font-bold">/data (or /storage/app/public without Docker)</li>
                                <ul class="ml-4">
                                    <li class="flex gap-1 font-bold"><LucideFolder />/media</li>
                                    <ul class="ml-4">
                                        <li class="flex flex-wrap items-center gap-1 font-bold">
                                            <ProiconsLibrary />
                                            /library1
                                            <p class="text-xs leading-none font-normal dark:text-neutral-400">-</p>
                                            <p class="text-xs leading-none font-normal dark:text-neutral-400">Each library will show all of it's folders on the same page</p>
                                        </li>
                                        <ul class="ml-4">
                                            <li class="flex gap-1 font-bold"><LucideFolder /> /folder1</li>
                                            <ul class="ml-4">
                                                <li class="flex items-center gap-1">
                                                    video1.mp4
                                                    <p class="text-xs leading-none dark:text-neutral-400">-</p>
                                                    <p class="text-xs leading-none dark:text-neutral-400">Each video will have it's own link by library/folder/?video=id</p>
                                                </li>
                                                <li>video2.mp4</li>
                                            </ul>
                                            <li class="flex gap-1 font-bold"><LucideFolder /> /folder2</li>
                                            <ul class="ml-4">
                                                <li>video1.mkv</li>
                                                <li>video2.mp4</li>
                                            </ul>
                                        </ul>
                                        <li class="flex gap-1 font-bold"><ProiconsLibrary />/library2</li>
                                        <ul class="ml-4">
                                            <li class="flex gap-1 font-bold"><LucideFolder /> /folder1</li>
                                            <ul class="ml-4">
                                                <li>song1.wav</li>
                                                <li>song2.ogg</li>
                                            </ul>
                                            <li class="flex gap-1 font-bold"><LucideFolder />/folder2</li>
                                            <ul class="ml-4">
                                                <li>song1.mp3</li>
                                                <li>song2.mp3</li>
                                            </ul>
                                        </ul>
                                    </ul>
                                </ul>
                            </ul>
                        </div>
                    </li>
                    <li class="flex flex-wrap items-center gap-1">
                        <p>
                            3. <RouterLink :class="`text-primary-muted underline decoration-1`" to="/dashboard/tasks">Start an "Index Files Task"</RouterLink> to discover all the
                            videos you have organised.
                        </p>
                        <p v-show="setupData?.folder_count" class="text-success ms-auto text-xs font-bold dark:text-green-700">Done!</p>
                    </li>
                    <li class="flex flex-wrap items-center gap-1">
                        <p>
                            4. <RouterLink :class="`text-primary-muted underline decoration-1`" to="/dashboard/tasks">Start a "Verify Files Task"</RouterLink> to generate metadata
                            for all of your videos.
                        </p>
                        <p v-show="setupData?.media_count" class="text-success ms-auto text-xs font-bold dark:text-green-700">Done!</p>
                    </li>
                    <li>5. <RouterLink to="/">Enjoy</RouterLink> your media library!</li>
                </ul>
            </section>
        </template>
        <template v-slot:sidebar> </template>
    </LayoutBase>
</template>