Add installation chapter

Signed-off-by: trivernis <trivernis@protonmail.com>
gh-pages
trivernis 2 years ago
parent b041bc934a
commit 47f53b84e6
Signed by: Trivernis
GPG Key ID: DFFFCC2C7A02DB45

@ -1,31 +1,24 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: mediarepo
email: me@trivernis.net
description: >- # this means to ignore newlines until "baseurl:"
description: >-
Mediarepo is a tool for managing media files. It works similar to image boards
(boorus) as it allows one to assign tags to media entries and search for entries by using those tags.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
baseurl: ""
url: "https://mediarepo.trivernis.dev"
github_username: Trivernis
# Build settings
plugins:
- jekyll-feed
collections:
docs:
output: true
sort_by: sort_key
kramdown:
syntax_highlighter: rouge
line_numbers: true
badges:
- img: https://img.shields.io/github/v/release/trivernis/mediarepo?include_prereleases&style=for-the-badge
href: https://github.com/Trivernis/mediarepo/releases
@ -36,11 +29,5 @@ badges:
- img: https://img.shields.io/aur/license/mediarepo?style=for-the-badge
href: https://github.com/Trivernis/mediarepo/blob/main/LICENSE
# Build settings
plugins:
- jekyll-feed
collections:
docs:
output: true
sort_by: sort_key
urls:
releases: https://github.com/Trivernis/mediarepo/releases

@ -0,0 +1,53 @@
---
layout: page
title: Installation
sort_key: 10
---
## Manual installation
The minimal setup of mediarepo only requires the client
application (mediarepo-ui). This allows you to connect to remote repositories
via IP but not to create and open local repositories.
In order to open local repositories you also need to have the
*mediarepo-daemon* application installed on your system.
This application manages a single repository and enables you to
have it running in the background while using minimal resources.
Both daemon and client can be downloaded from the [Releases]({{ site.urls.releases }})
page.
The client application comes in several bundle variants
and as a single executable. Depending on your system configuration
you can use the executable directly or need to use one of the bundles.
I haven't really tested that so you have to figure it out yourself.
The daemon application only comes a a single executable as it only requires
minimal external dependencies which should be installed on most systems.
You can use the daemon manually to initialize and host a repository or you
can use the client to do the initialization and daemon startup for you.
When starting the client for the first time it creates a config `settings.toml` file somewhere
in your users application config folder (usually `$HOME/.config/mediarepo` on linux,
somewhere in `%APPDATA%` on windows and in the nether dimension on mac).
This application contains an entry `daemon_path` which points to the
`mediarepo-daemon` executable on your system. The client application searches for the daemon
executable in the `PATH` automatically on startup. If it can't find it the entry will stay empty.
If this entry doesn't exist or has an empty value, you have to
configure it yourself and set it to the folder you placed the daemon executable in.
Either way a valid configuration for local usage should look as follows:
```toml
# settings.toml
daemon_path = "/usr/bin/mediarepo-daemon"
```
## AUR
Mediarepo can also be installed from the AUR which is much easier than
installing it the manual way (not everyone uses arch tho). All you need to install
is the `mediarepo` package for the client and the `mediarepo-daemon` package for
the daemon. As both applications are installed in `/usr/bin` the client should be
able to find the daemon executable automatically.

@ -1,18 +0,0 @@
---
layout: page
title: doc1
sort_key: 2
draft: true
---
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut diam quam nulla porttitor massa id. Venenatis lectus magna fringilla urna porttitor rhoncus dolor. Purus gravida quis blandit turpis cursus in hac habitasse platea. Mauris augue neque gravida in fermentum et sollicitudin ac orci. Non consectetur a erat nam at lectus. Egestas integer eget aliquet nibh praesent. Quisque id diam vel quam elementum. Ullamcorper velit sed ullamcorper morbi tincidunt ornare massa. Purus sit amet volutpat consequat mauris nunc congue nisi vitae. Vulputate dignissim suspendisse in est ante in nibh mauris.
In aliquam sem fringilla ut. Aenean pharetra magna ac placerat vestibulum. Augue mauris augue neque gravida in fermentum et. Quis auctor elit sed vulputate mi sit. Praesent elementum facilisis leo vel fringilla est ullamcorper eget nulla. Ut faucibus pulvinar elementum integer enim. Turpis egestas sed tempus urna et pharetra pharetra massa. Et ligula ullamcorper malesuada proin libero nunc consequat interdum. Risus commodo viverra maecenas accumsan. Id diam maecenas ultricies mi eget mauris.
![](/assets/images/screenshot-1.png)
Vitae aliquet nec ullamcorper sit amet risus. Posuere lorem ipsum dolor sit. Sodales neque sodales ut etiam sit. Enim nunc faucibus a pellentesque sit amet porttitor. Justo laoreet sit amet cursus sit amet dictum. Nunc sed velit dignissim sodales ut. At lectus urna duis convallis convallis tellus id interdum. Mauris commodo quis imperdiet massa tincidunt nunc. Nisl nisi scelerisque eu ultrices vitae auctor eu augue ut. Nunc sed id semper risus. Phasellus faucibus scelerisque eleifend donec pretium.
Viverra vitae congue eu consequat ac felis donec et odio. Convallis a cras semper auctor. Faucibus vitae aliquet nec ullamcorper sit amet risus nullam. Mollis aliquam ut porttitor leo. Ante metus dictum at tempor commodo ullamcorper a lacus vestibulum. Aliquam ultrices sagittis orci a scelerisque purus. Eros in cursus turpis massa tincidunt dui ut ornare lectus. Elementum pulvinar etiam non quam. Scelerisque viverra mauris in aliquam sem fringilla ut. Varius sit amet mattis vulputate enim nulla aliquet. Cras semper auctor neque vitae. Purus semper eget duis at tellus at urna condimentum mattis. Est ultricies integer quis auctor.
Suspendisse potenti nullam ac tortor. Tellus mauris a diam maecenas sed enim. Tempor nec feugiat nisl pretium fusce id velit ut tortor. Nec feugiat nisl pretium fusce id velit. Eget velit aliquet sagittis id consectetur purus. Eget velit aliquet sagittis id consectetur purus ut. Lorem donec massa sapien faucibus et molestie ac. Hac habitasse platea dictumst vestibulum rhoncus. Eleifend quam adipiscing vitae proin sagittis nisl rhoncus mattis. Neque convallis a cras semper auctor neque vitae tempus. Elementum curabitur vitae nunc sed velit dignissim sodales ut eu. Dignissim enim sit amet venenatis urna cursus. Convallis a cras semper auctor neque vitae tempus quam. Dictum varius duis at consectetur. Sed tempus urna et pharetra pharetra massa massa ultricies mi. Ac odio tempor orci dapibus ultrices in. Pharetra pharetra massa massa ultricies mi. Tincidunt vitae semper quis lectus nulla. Aliquam eleifend mi in nulla posuere sollicitudin aliquam. Lacus sed turpis tincidunt id.

@ -10,9 +10,10 @@ pre {
}
code {
color: $color-code;
//color: $color-code;
font-size: $body-font-size;
padding: 1px 0px;
font: 'Fira Code', FiraCode, monospace;
}

@ -6,6 +6,7 @@ $magenta: #ff00f2;
$magenta-small: rgb(236, 0, 205);
$white: rgb(255, 255, 255);
$white-text: rgb(238, 238, 238);
$code: #ffc3ef;
// Config
$color-background: $black-alt!default;
@ -14,7 +15,7 @@ $color-foreground: $white !default;
$color-title: $white !default;
$color-body-text: $white !default;
$color-text-accent: $magenta !default;
$color-code: $magenta-small !default;
$color-code: $code !default;
$color-nav-link: $magenta !default;
$color-primary-link: $magenta !default;

@ -17,7 +17,7 @@ $h5-size: 16px !default;
$h6-size: 12px !default;
// Default border color
$color-border: #ddd !default;
$color-border: rgb(64, 59, 82) !default;
// Container width
$container-width: 64em;

@ -0,0 +1,65 @@
/*.highlight pre { background-color: #272822; }
.highlight .hll { background-color: #272822; }*/
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
.highlight .gh { } /* Generic Heading & Diff Header */
.highlight .gu { color: #75715e; } /* Generic.Subheading & Diff Unified/Comment? */
.highlight .gd { color: #f92672; } /* Generic.Deleted & Diff Deleted */
.highlight .gi { color: #a6e22e; } /* Generic.Inserted & Diff Inserted */

@ -5,3 +5,4 @@
// Import partials from `sass_dir` and set theme here
@import "theme.scss";
@import "monokai.css"
Loading…
Cancel
Save