mirror of
https://github.com/krateng/maloja.git
synced 2025-07-09 03:04:07 -04:00
Shortened Readme a bit
This commit is contained in:
parent
e3a551cb12
commit
91e51a0167
84
README.md
84
README.md
@ -4,7 +4,7 @@
|
|||||||
[](https://pypi.org/project/malojaserver/)
|
[](https://pypi.org/project/malojaserver/)
|
||||||
[](https://hub.docker.com/r/krateng/maloja)
|
[](https://hub.docker.com/r/krateng/maloja)
|
||||||
|
|
||||||
Simple self-hosted music scrobble database to create personal listening statistics. No recommendations, no social network, no nonsense.
|
Simple self-hosted music scrobble database to create personal listening statistics.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@ -15,9 +15,9 @@ You can check [my own Maloja page](https://maloja.krateng.ch) as an example inst
|
|||||||
* [Features](#features)
|
* [Features](#features)
|
||||||
* [How to install](#how-to-install)
|
* [How to install](#how-to-install)
|
||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
|
* [Docker / Podman](#docker--podman)
|
||||||
* [PyPI](#pypi)
|
* [PyPI](#pypi)
|
||||||
* [From Source](#from-source)
|
* [From Source](#from-source)
|
||||||
* [Docker / Podman](#docker--podman)
|
|
||||||
* [Extras](#extras)
|
* [Extras](#extras)
|
||||||
* [How to use](#how-to-use)
|
* [How to use](#how-to-use)
|
||||||
* [Basic control](#basic-control)
|
* [Basic control](#basic-control)
|
||||||
@ -44,37 +44,10 @@ You can check [my own Maloja page](https://maloja.krateng.ch) as an example inst
|
|||||||
|
|
||||||
Maloja should run on any x86 or ARM machine that runs Python.
|
Maloja should run on any x86 or ARM machine that runs Python.
|
||||||
|
|
||||||
I can support you with issues best if you use **Alpine Linux**.
|
It is highly recommended to use **Docker** or **Podman**.
|
||||||
|
|
||||||
Your CPU should have a single core passmark score of at the very least 1500. 500 MB RAM should give you a decent experience, but performance will benefit greatly from up to 2 GB.
|
Your CPU should have a single core passmark score of at the very least 1500. 500 MB RAM should give you a decent experience, but performance will benefit greatly from up to 2 GB.
|
||||||
|
|
||||||
### PyPI
|
|
||||||
|
|
||||||
You can install Maloja with
|
|
||||||
|
|
||||||
```console
|
|
||||||
pip install malojaserver
|
|
||||||
```
|
|
||||||
|
|
||||||
To make sure all dependencies are installed, you can also use one of the included scripts in the `install` folder.
|
|
||||||
|
|
||||||
### From Source
|
|
||||||
|
|
||||||
Clone this repository and enter the directory with
|
|
||||||
|
|
||||||
```console
|
|
||||||
git clone https://github.com/krateng/maloja
|
|
||||||
cd maloja
|
|
||||||
```
|
|
||||||
|
|
||||||
Then install all the requirements and build the package, e.g.:
|
|
||||||
|
|
||||||
```console
|
|
||||||
sh ./install/install_dependencies_alpine.sh
|
|
||||||
pip install -r requirements.txt
|
|
||||||
pip install .
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker / Podman
|
### Docker / Podman
|
||||||
|
|
||||||
Pull the [latest image](https://hub.docker.com/r/krateng/maloja) or check out the repository and use the included Containerfile.
|
Pull the [latest image](https://hub.docker.com/r/krateng/maloja) or check out the repository and use the included Containerfile.
|
||||||
@ -111,37 +84,47 @@ The modified run command with these variables would look like:
|
|||||||
docker run -e PUID=1000 -e PGID=1001 -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
|
docker run -e PUID=1000 -e PGID=1001 -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### PyPI
|
||||||
|
|
||||||
|
You can install Maloja with
|
||||||
|
|
||||||
|
```console
|
||||||
|
pip install malojaserver
|
||||||
|
```
|
||||||
|
|
||||||
|
To make sure all dependencies are installed, you can also use one of the included scripts in the `install` folder.
|
||||||
|
|
||||||
|
### From Source
|
||||||
|
|
||||||
|
Clone this repository and enter the directory with
|
||||||
|
|
||||||
|
```console
|
||||||
|
git clone https://github.com/krateng/maloja
|
||||||
|
cd maloja
|
||||||
|
```
|
||||||
|
|
||||||
|
Then install all the requirements and build the package, e.g.:
|
||||||
|
|
||||||
|
```console
|
||||||
|
sh ./install/install_dependencies_alpine.sh
|
||||||
|
pip install -r requirements.txt
|
||||||
|
pip install .
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Extras
|
### Extras
|
||||||
|
|
||||||
* If you'd like to display images, you will need API keys for [Last.fm](https://www.last.fm/api/account/create) and [Spotify](https://developer.spotify.com/dashboard/applications). These are free of charge!
|
* If you'd like to display images, you will need API keys for [Last.fm](https://www.last.fm/api/account/create) and [Spotify](https://developer.spotify.com/dashboard/applications). These are free of charge!
|
||||||
|
|
||||||
* Put your server behind a reverse proxy for SSL encryption. Make sure that you're proxying to the IPv6 or IPv4 address according to your settings.
|
* Put your server behind a reverse proxy for SSL encryption. Make sure that you're proxying to the IPv6 or IPv4 address according to your settings.
|
||||||
|
|
||||||
* You can set up a cronjob to start your server on system boot, and potentially restart it on a regular basis:
|
|
||||||
|
|
||||||
```
|
|
||||||
@reboot sleep 15 && maloja start
|
|
||||||
42 0 7 * * maloja restart
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
### Basic control
|
### Basic control
|
||||||
|
|
||||||
Start and stop the server in the background with
|
When not running in a container, you can run the application with `maloja run`. You can also run it in the background with
|
||||||
|
`maloja start` and `maloja stop`, but this might not be supported in the future.
|
||||||
```console
|
|
||||||
maloja start
|
|
||||||
maloja stop
|
|
||||||
maloja restart
|
|
||||||
```
|
|
||||||
|
|
||||||
If you need to run the server in the foreground, use
|
|
||||||
|
|
||||||
```console
|
|
||||||
maloja run
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Data
|
### Data
|
||||||
@ -161,7 +144,6 @@ If you would like to import your previous scrobbles, use the command `maloja imp
|
|||||||
maloja import my_last_fm_export.csv
|
maloja import my_last_fm_export.csv
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
To backup your data, run `maloja backup`, optional with `--include_images`.
|
To backup your data, run `maloja backup`, optional with `--include_images`.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user