From 9b49c1e8def5a0d37851052c0b56ee87fb41a4bc Mon Sep 17 00:00:00 2001 From: Lee Peuker Date: Thu, 12 Jan 2023 13:40:26 +0100 Subject: [PATCH 1/5] Split install section into two sections (one with and one without docker) --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4c52f39d..994fafde 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ Demo installation can be found [here](https://demo.movary.org/) (login email `te ![Movary Dashboard Example](https://i.imgur.com/690Rr80.png) 1. [About](#about) -2. [Install via docker](#install-via-docker) +2. [Install](#install) + 1. [With Docker (recommended)](#install-with-docker) + 2. [Without Docker](#install-without-docker) 3. [Important: First steps](#important-first-steps) 4. [Features](#features) 1. [Tmdb Sync](#tmdb-sync) @@ -57,11 +59,11 @@ Movary has support for multiple users accounts in case you want to share your in **Disclaimer:** This project is still in an experimental (but imo completely usable) state. I am planning to add more and improve existing features before creating a 1.0 realease, which can lead to sudden breaking changes until then, so keep the release notes in mind when updating. - +## Install -## Install via docker +### Install with docker -This is the preferred and currently only tested way to run the app. +This is the recommended way to run the app. You must provide a tmdb api key (get one [here](https://www.themoviedb.org/settings/api)). @@ -131,6 +133,12 @@ volumes: movary-storage: ``` +Continue with [Important: First steps](#important-first-steps) + +### Install without docker + +coming soon... + ## Important: First steps You can run movary commands in docker via e.g. `docker exec movary php bin/console.php` From ebf785f081b7ded63936302af1005cb282bfc570 Mon Sep 17 00:00:00 2001 From: Lee Peuker Date: Thu, 12 Jan 2023 13:44:41 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 994fafde..55e665a0 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Demo installation can be found [here](https://demo.movary.org/) (login email `te 1. [About](#about) 2. [Install](#install) - 1. [With Docker (recommended)](#install-with-docker) + 1. [With Docker (recommended)](#install-with-docker-recommended) 2. [Without Docker](#install-without-docker) 3. [Important: First steps](#important-first-steps) 4. [Features](#features) @@ -61,7 +61,7 @@ which can lead to sudden breaking changes until then, so keep the release notes ## Install -### Install with docker +### Install with docker (recommended) This is the recommended way to run the app. From 257bdc726ebc976d8cee56165578850a76376f27 Mon Sep 17 00:00:00 2001 From: Lee Peuker Date: Thu, 12 Jan 2023 13:47:01 +0100 Subject: [PATCH 3/5] Update docker install readme section --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 994fafde..46040f1c 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,8 @@ volumes: movary-storage: ``` +You can run movary commands in docker via e.g. `docker exec movary php bin/console.php` + Continue with [Important: First steps](#important-first-steps) ### Install without docker @@ -141,9 +143,9 @@ coming soon... ## Important: First steps -You can run movary commands in docker via e.g. `docker exec movary php bin/console.php` +You can execute movary commands via `php bin/console.php` -1. Execute missing database migrations: `php bin/console.php database:migration:migrate` (on **initial installation** and ideally **after every update**) +1. Execute database migrations: `php bin/console.php database:migration:migrate` (after **initial installation** and ideally **after every update**) 2. Create initial user - via web UI by visiting the movary lading page for the first time - via cli `php bin/console.php user:create email@example.com password username` From 7b8c5755a05d6738883091468877675206609d76 Mon Sep 17 00:00:00 2001 From: Lee Peuker Date: Thu, 12 Jan 2023 14:33:31 +0100 Subject: [PATCH 4/5] Add raw dockerless install instruction --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e58a7db..2a6df36f 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,18 @@ Continue with [Important: First steps](#important-first-steps) ### Install without docker -coming soon... +Requirements: +- PHP 8.1 +- git +- composer + +``` +git clone https://github.com/leepeuker/movary.git . +cp .env.production.example .env +composer install --no-dev +php bin/console.php storage:link +``` + ## Important: First steps From a14dd7b304c614acaa613042eebbfdcc7da19164 Mon Sep 17 00:00:00 2001 From: Lee Peuker Date: Thu, 12 Jan 2023 19:49:14 +0100 Subject: [PATCH 5/5] Update install without docker readme section --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e01584d6..d5bf63f7 100644 --- a/README.md +++ b/README.md @@ -137,10 +137,13 @@ Continue with [Important: First steps](#important-first-steps) ### Install without docker -Requirements: +**Software requirements:** + - PHP 8.1 - git - composer +- web server +- supervisor (optional) ``` git clone https://github.com/leepeuker/movary.git . @@ -149,9 +152,17 @@ composer install --no-dev php bin/console.php storage:link ``` +- Use the `.env` file to set the environment variables +- Setup web server host for php (`public` directory as document root) +- Make sure that the permissions on the `storage` directory are set correctly (the php should be able to write to it) +- Use supervisor to continuously process jobs, see `settings/supervisor/movary.conf` for an example config + +Continue with [Important: First steps](#important-first-steps) + + ## Important: First steps -You can run movary commands in docker via e.g. `docker exec movary php bin/console.php` +You can run movary commands via `php bin/console.php` 1. Execute missing database migrations: `php bin/console.php database:migration:migrate` (on **initial installation** and ideally **after every update**) 2. Create initial user @@ -234,9 +245,10 @@ You can select what you want movary to scrobble (movie views and/or ratings) via ### Jellyfin Scrobbler -Automatically track movies watched via Jellyin with Movary. +Automatically track movies watched via Jellyin with Movary. -You can generate your Jellyfin webhook url on the Jellyfin settings page (`/setting/jellyfin`) and configure it in Jellyfin via the [webhook plugin](https://github.com/jellyfin/jellyfin-plugin-webhook). +You can generate your Jellyfin webhook url on the Jellyfin settings page (`/setting/jellyfin`) and configure it in Jellyfin via +the [webhook plugin](https://github.com/jellyfin/jellyfin-plugin-webhook). ### Trakt.tv Import @@ -310,7 +322,8 @@ A: Currently there is no active development for supporting more media types. Con Q: Can I share my history and ratings publicly? -A: Yes, you can set (e.g. via `/settings` page) your `Privacy` levels and decide who is allowed to view your data. All page urls starting with `/users//...` (= pages with a user selector at the top) can be set to be publicly visible. +A: Yes, you can set (e.g. via `/settings` page) your `Privacy` levels and decide who is allowed to view your data. All page urls starting with `/users//...` (= pages with +a user selector at the top) can be set to be publicly visible. ## Development