From d7038140ed4e82b1764854e850314bcf80277f53 Mon Sep 17 00:00:00 2001 From: Poussinou Date: Sat, 23 Nov 2024 17:06:01 +0000 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a70fc5..077b708 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The recolldroid android app requires that a signed cert be installed on the serv # Status New project, still settling in so installation is rough just now (but improving). -To install the UI at the moment, you'll need to install AndroidStudio and then grab the source and install to your device via a remote debug session. The intention is upload this to FDroid and possibly Google Play Store (in that order). +To install the UI at the moment, you'll need to install AndroidStudio and then grab the source and install to your device via a remote debug session. Docker images are provided for the server side - you'll need to choose amd64 or arm64 as the recoll packages for those two platforms come from different package repos. @@ -26,10 +26,16 @@ Docker images are provided for the server side - you'll need to choose amd64 or ## UI Installation -To install the UI you'll have to install AndroidStudio on your machine and upload the app via a remote debug session. The goal is to make the UI available on FDroid and possibly Google Play Store in the near future. +To install the UI you'll have to install AndroidStudio on your machine and upload the app via a remote debug session. To install the server, download one of the docker images from [here](https://gitlab.com/gbygrave/recolldroid-server/container_registry), making sure to select the right image for your hardware (either, amd64 or arm64). Docker images are made available to ease installation of the server in the first instance, however I imagine one would typically run nginx/nginx-unit/fast-api independently of recolldroid - perhaps in an incus system container or vm - to provide self hosted services generally and install recolldroid on top of this infrastructure. +[Get it on F-Droid](https://f-droid.org/packages/org.grating.recolldroid/) + +Or download from the [Releases Section](https://gitlab.com/gbygrave/recolldroid/-/releases) here on Gitlab. + ### Server Installation The RecollDroid server project can be found [here](https://gitlab.com/gbygrave/recolldroid-server). The server side code is fairly minimal is it only deals with connectivity to the recoll python api and leaves security, marshalling and communication to other things. The only hard pre-requisites (without modifying the code) are FastAPI, the use of basic auth. I personally set this up using Nginx and Nginx-Unit and that's what the docker images do, but other setups are certainly conceivable. -- GitLab