Skip to content

Commit

Permalink
Fix issue with internal links for GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
AgustinSRG committed Nov 4, 2023
1 parent 1ea84a3 commit a4841fd
Show file tree
Hide file tree
Showing 15 changed files with 72 additions and 71 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/Console Client/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Run the tool help command to see the manual:
pmv-cli --help
```

For more information, check the [Manual](/docs/console-client/manual)
For more information, check the [Manual]({{< baseurl >}}docs/console-client/manual)
2 changes: 1 addition & 1 deletion content/en/docs/Getting started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ The installation guides also explain how to create a vault and run it in your sy

## Next steps

After installing and creating your first vault, you may want to check out the [Tutorials](/docs/tutorials/) section for more guides and tutorial on how to use PersonalMediaVault.
After installing and creating your first vault, you may want to check out the [Tutorials]({{< baseurl >}}docs/tutorials/) section for more guides and tutorial on how to use PersonalMediaVault.

2 changes: 1 addition & 1 deletion content/en/docs/Getting started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ services:
command: --daemon --clean --log-requests --skip-lock --vault-path /vault
```

Check the [server options](/docs/technical-documentation/server-options/) for more information of all the available options to run the server.
Check the [server options]({{< baseurl >}}docs/technical-documentation/server-options/) for more information of all the available options to run the server.

## Running the vault

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Getting started/install-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The installer will add an option to the file explorer to open a folder with Pers

Create a new folder, and use that option to open with PersonalMediaVault.

![Open with PersonalMediaVault](/images/en/windows-open-with.jpg)
![Open with PersonalMediaVault]({{< baseurl >}}images/en/windows-open-with.jpg)

That will open the launcher, asking you for an initial username and password for your vault.

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,6 @@ The server is meant to be run by the owner of the media files, either in local o

## Where should I go next?

* [Getting Started](/docs/getting-started/): Download, install and run PersonalMediaVault
* [Tutorials](/docs/tutorials/): Check out some guides and tutorials on how to use PersonalMediaVault.
* [Getting Started]({{< baseurl >}}docs/getting-started/): Download, install and run PersonalMediaVault
* [Tutorials]({{< baseurl >}}docs/tutorials/): Check out some guides and tutorials on how to use PersonalMediaVault.

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document specifies the vault frontend customization capabilities implemente

You can customize the vault frontend title and also setup custom CSS code if you need it. Simply go to `Settings` and then `Advanced Settings`.

![Screenshot](/images/en/advanced-settings-3.jpg)
![Screenshot]({{< baseurl >}}images/en/advanced-settings-3.jpg)

The custom title will affect the page base title.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [guides, tutorials, technical, documentation]

This technical guide explains how to set up PersonalMediaVault as a service in a Linux machine using systemd.

Make sure to follow the [installation guide on Linux](/docs/getting-started/install-linux-deb/) before doing this. This guide expects you to have PersonalMediaVault already installed in your system.
Make sure to follow the [installation guide on Linux]({{< baseurl >}}docs/getting-started/install-linux-deb/) before doing this. This guide expects you to have PersonalMediaVault already installed in your system.

The first step for creating a systemd service is to create an user for that service.

Expand Down Expand Up @@ -67,7 +67,7 @@ WantedBy=multi-user.target

Note: You may want to change some options. For that, make sure to check the following:

- [Server options for PersonalMediaVault](/docs/technical-documentation/server-options/)
- [Server options for PersonalMediaVault]({{< baseurl >}}docs/technical-documentation/server-options/)
- [Systemd service file manual](https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html)

After you saved the service file, and exited the editor, run the following command to enable the service, so it runs every time the system starts:
Expand Down
18 changes: 9 additions & 9 deletions content/en/docs/Tutorials/01-setting-up-everything.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Most modern browsers are supported, including Chromium-based browser, Firefox-ba

The fist screen you will see is a login screen asking for your vault credentials to unlock the vault. You have to use the credentials you provide when creating the vault. If you didn't specify any credentials, by default, the username is `admin` and the password is also `admin`.

![Screenshot](/images/en/unlock-screen.jpg)
![Screenshot]({{< baseurl >}}images/en/unlock-screen.jpg)

After you successfully log into your vault, you will be presented with the PersonalMediaVault main interface:

![Screenshot](/images/en/initial-screen.jpg)
![Screenshot]({{< baseurl >}}images/en/initial-screen.jpg)

Let's get familiar with the interface elements!

Expand Down Expand Up @@ -50,7 +50,7 @@ The top bar buttons are the following, from left to right:

The vault settings menu has all the options you need to set your vault up. Let's dive into them and make the necessary actions.

![Screenshot](/images/en/vault-settings.jpg)
![Screenshot]({{< baseurl >}}images/en/vault-settings.jpg)

### Change theme

Expand All @@ -76,7 +76,7 @@ Click in the **Change username** in order to change your username. This is the u

In order to change it, you must also provide your current password.

![Screenshot](/images/en/change-username.jpg)
![Screenshot]({{< baseurl >}}images/en/change-username.jpg)

### Change password

Expand All @@ -88,7 +88,7 @@ Make sure to use a very strong password, using letters (uppercase and lowercase)

Is it recommended to use a password manager, and making a backup of your password. If you lose your password, it will be impossible to recover the vault content, since it's encrypted with that password.

![Screenshot](/images/en/change-password.jpg)
![Screenshot]({{< baseurl >}}images/en/change-password.jpg)

### Administrate accounts

Expand All @@ -115,15 +115,15 @@ The first tab, called **General** will allow you to configure the following:
- The max number of threads to use for each task. By default is `0`, meaning it will use as many as optimal. You can set it in order to restrict the CPU usage.
- The video previews interval, in seconds. Each interval, PersonalMediaVault will make a preview of a video in order to display them when hovering the timeline.

![Screenshot](/images/en/advanced-settings-1.jpg)
![Screenshot]({{< baseurl >}}images/en/advanced-settings-1.jpg)

The second tab, called **Extra resolutions** will allow you to enable certain extra resolutions to use for small screens, in order to save memory and bandwidth. If you plan to use from a tablet or a mobile device, you may want to enable some of them.

![Screenshot](/images/en/advanced-settings-2.jpg)
![Screenshot]({{< baseurl >}}images/en/advanced-settings-2.jpg)

The third tab, called **Custom style** will let you specify custom CSS code to apply to the web interface. You can use this to make your own theme. However, this option is very advanced and requires CSS knowledge. If you do not have such knowledge or you are not interesting in a custom theme, just ignore this option.

![Screenshot](/images/en/advanced-settings-3.jpg)
![Screenshot]({{< baseurl >}}images/en/advanced-settings-3.jpg)

### Batch operation

Expand All @@ -141,4 +141,4 @@ You can apply any of the following operations:

This can be useful if you want to make a change to many media assets, saving you time.

![Screenshot](/images/en/batch-operation.jpg)
![Screenshot]({{< baseurl >}}images/en/batch-operation.jpg)
6 changes: 3 additions & 3 deletions content/en/docs/Tutorials/02-uploading.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ weight: 2

In order to add media files into your vault, you may use the **Upload** option in the main menu.

![Screenshot](/images/en/upload-1.jpg)
![Screenshot]({{< baseurl >}}images/en/upload-1.jpg)

You can **drag and drop files** into the box with dotted border, or **click it to open the file selector**.

Once you select a file, a modal will open asking you to confirm it, while allowing you to add the media into an album, and add tags. This is very useful when you upload multiple times at once that share some tags.

![Screenshot](/images/en/upload-2.jpg)
![Screenshot]({{< baseurl >}}images/en/upload-2.jpg)

When the upload process finishes, you can check the uploaded media in the **Ready** tab.

![Screenshot](/images/en/upload-3.jpg)
![Screenshot]({{< baseurl >}}images/en/upload-3.jpg)

If the upload process fails for some reason, it will be placed in the **Error** tab.

Expand Down
24 changes: 12 additions & 12 deletions content/en/docs/Tutorials/03-video-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,33 @@ The PersonalMediaVault video player is a feature rich player based on the YouTub
- At the top-right, you have a button to open the video metadata editor.
- At the bottom you have the player controls, and on top of them, you have the timeline.

![Screenshot](/images/en/video-player.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player.jpg)

## Basic controls

In order to play or pause, you can simply click the player at the center, use the play button in the player controls bar, or using a keyboard shortcut: **Space Bar** or **K**.

![Screenshot](/images/en/video-player-play.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-play.jpg)

In order to change the volume, you can use the volume control in the player controls bar, which displays a slider when hovering it or clicking it. You can also use a keyboard shortcut, being the **Up** and **Down** arrow keys, which will change the volume by 5%. You can press **Shift** while using the vertical arrow keys in order to fine-tune the volume by changing it 1% each key press.

You can mute or un-mute the video by clicking on the volume control in the player controls bar, or using the key **M**.

![Screenshot](/images/en/video-player-volume.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-volume.jpg)

By pressing the configuration button or the **S** key, you can open the [video player configuration](#configuration).

![Screenshot](/images/en/video-player-config-btn.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-config-btn.jpg)

By pressing the full screen button, or the **F** key, you can toggle the full screen mode for the video player.

![Screenshot](/images/en/video-player-full-screen.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-full-screen.jpg)

## Timeline

You can hover the timeline in order to get the timestamp you are hovering into, and an image preview, if available.

![Screenshot](/images/en/video-player-timeline.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-timeline.jpg)

You can click the timeline in order to change the current time.

Expand All @@ -55,7 +55,7 @@ Also, if the player is paused, you can use the **dot** and **comma** keys to go

You can open the player configuration by pressing the configuration button or the **S** key.

![Screenshot](/images/en/video-player-config.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-config.jpg)

You can find several options:

Expand All @@ -71,7 +71,7 @@ You can find several options:

When right clicking with a mouse, or with a long tap in touch devices, it will open the player context menu, with several options for fast access to them.

![Screenshot](/images/en/video-player-context-menu.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-context-menu.jpg)

You can find several options:

Expand All @@ -88,7 +88,7 @@ You can find several options:

You can open the player editor by clicking the expand button at the top right corner of the player. Also you can press the **E** key.

![Screenshot](/images/en/video-player-editor.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-editor.jpg)

The player editor allows you to change any aspect of the video.

Expand All @@ -106,7 +106,7 @@ If you upload a Matroska file (`.mkv` extension) to the vault, the available sub

When a video has subtitles, you can select them at the player configuration menu, while also being able to customize their style.

![Screenshot](/images/en/video-player-subtitles.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-subtitles.jpg)

### Audio tracks

Expand All @@ -116,13 +116,13 @@ If you upload a Matroska file (`.mkv` extension) to the vault, the available aud

When a video has extra audio tracks, you can select the one that will play at the player configuration menu.

![Screenshot](/images/en/video-player-audios.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-audios.jpg)

### Time slices

You can split the video in different slices by clicking the option in the context menu, or pressing the **N** key. This will open an editor where you can add time slices, specifying the start time, and a name.

![Screenshot](/images/en/video-player-time-slices.jpg)
![Screenshot]({{< baseurl >}}images/en/video-player-time-slices.jpg)

You can also change the time slices in text mode by going to the **Time slices** tab of the player editor.

Expand Down
16 changes: 8 additions & 8 deletions content/en/docs/Tutorials/04-image-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The PersonalMediaVault image viewer is very similar to the video player:
- At the top-right, you have a button to open the image metadata editor.
- At the bottom you have the viewer controls.

![Screenshot](/images/en/image-viewer.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer.jpg)

## Basic controls

Expand All @@ -25,21 +25,21 @@ You can change the image scale with the scale control, which displays when hover
- Drag the scale control or press the **+** and **-** keys to increase or decrease the scale by 10% respectively.
- You can press the **Shift** key, along with the **+** and **-** keys to increase or decrease the scale by 1% respectively.

![Screenshot](/images/en/image-viewer-scale.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-scale.jpg)

By pressing the configuration button or the **S** key, you can open the [image viewer configuration](#configuration).

![Screenshot](/images/en/image-viewer-config-btn.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-config-btn.jpg)

By pressing the full screen button, or the **F** key, you can toggle the full screen mode for the image viewer.

![Screenshot](/images/en/image-viewer-full-screen.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-full-screen.jpg)

## Configuration

You can open the viewer configuration by pressing the configuration button or the **S** key.

![Screenshot](/images/en/image-viewer-config.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-config.jpg)

You can find several options:

Expand All @@ -52,7 +52,7 @@ You can find several options:

When right clicking with a mouse, or with a long tap in touch devices, it will open the viewer context menu, with several options for fast access to them.

![Screenshot](/images/en/image-viewer-context-menu.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-context-menu.jpg)

You can find several options:

Expand All @@ -69,7 +69,7 @@ You can find several options:

You can open the viewer editor by clicking the expand button at the top right corner of the viewer. Also you can press the **E** key.

![Screenshot](/images/en/image-viewer-editor.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-editor.jpg)

The viewer editor allows you to change any aspect of the image.

Expand All @@ -87,7 +87,7 @@ When out of the image notes editor mode, they will be displayed as translucid sq

You can use image notes, for example, to name elements of the image, add extra information or translate texts in a foreign language.

![Screenshot](/images/en/image-viewer-notes.jpg)
![Screenshot]({{< baseurl >}}images/en/image-viewer-notes.jpg)

You can also change the image notes in text mode by going to the **Image Notes** tab of the viewer editor, very useful to import and export notes.

Expand Down
22 changes: 11 additions & 11 deletions content/en/docs/Tutorials/05-audio-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,33 @@ The PersonalMediaVault video player is very similar to the video player, adapted
- At the top-right, you have a button to open the audio metadata editor.
- At the bottom you have the player controls, and on top of them, you have the timeline.

![Screenshot](/images/en/audio-player.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player.jpg)

## Basic controls

In order to play or pause, you can simply click the player at the center, use the play button in the player controls bar, or using a keyboard shortcut: **Space Bar** or **K**.

![Screenshot](/images/en/audio-player-play.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-play.jpg)

In order to change the volume, you can use the volume control in the player controls bar, which displays a slider when hovering it or clicking it. You can also use a keyboard shortcut, being the **Up** and **Down** arrow keys, which will change the volume by 5%. You can press **Shift** while using the vertical arrow keys in order to fine-tune the volume by changing it 1% each key press.

You can mute or un-mute the audio by clicking on the volume control in the player controls bar, or using the key **M**.

![Screenshot](/images/en/audio-player-volume.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-volume.jpg)

By pressing the configuration button or the **S** key, you can open the [audio player configuration](#configuration).

![Screenshot](/images/en/audio-player-config-btn.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-config-btn.jpg)

By pressing the full screen button, or the **F** key, you can toggle the full screen mode for the audio player.

![Screenshot](/images/en/audio-player-full-screen.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-full-screen.jpg)

## Timeline

You can hover the timeline in order to get the timestamp you are hovering into.

![Screenshot](/images/en/audio-player-timeline.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-timeline.jpg)

You can click the timeline in order to change the current time.

Expand All @@ -55,7 +55,7 @@ Also, if the player is paused, you can use the **dot** and **comma** keys to go

You can open the player configuration by pressing the configuration button or the **S** key.

![Screenshot](/images/en/audio-player-config.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-config.jpg)

You can find several options:

Expand All @@ -68,7 +68,7 @@ You can find several options:

When right clicking with a mouse, or with a long tap in touch devices, it will open the player context menu, with several options for fast access to them.

![Screenshot](/images/en/audio-player-context-menu.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-context-menu.jpg)

You can find several options:

Expand All @@ -84,7 +84,7 @@ You can find several options:

You can open the player editor by clicking the expand button at the top right corner of the player. Also you can press the **E** key.

![Screenshot](/images/en/audio-player-editor.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-editor.jpg)

The player editor allows you to change any aspect of the audio.

Expand All @@ -100,13 +100,13 @@ You can add subtitles to the audio in the **Subtitles** tab of the player editor

When an audio has subtitles, you can select them at the player configuration menu, while also being able to customize their style.

![Screenshot](/images/en/audio-player-subtitles.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-subtitles.jpg)

### Time slices

You can split the audio in different slices by clicking the option in the context menu, or pressing the **N** key. This will open an editor where you can add time slices, specifying the start time, and a name.

![Screenshot](/images/en/audio-player-time-slices.jpg)
![Screenshot]({{< baseurl >}}images/en/audio-player-time-slices.jpg)

You can also change the time slices in text mode by going to the **Time slices** tab of the player editor.

Expand Down
Loading

0 comments on commit a4841fd

Please sign in to comment.