Home

Frickl Wiki

Frickl contains of two parts: the server side which handles the database, image import and API and the client side part (this repository) which puts a nice web-interface on top of the API.

Requirements

There are two different options when it comes to running Frickl yourself.

1. Use the Docker image.
2. Build and run Frickl manually.

Docker Image

Option 1 requires the least amount of configuration and it's the option I would recommend. I actually run the Docker image of Frickl on a Raspberry Pi 4 myself. All you need is a machine that has Docker installed. Most Linux distributions will have this available in their software sources. There are detailed installation instructions available on the Docker website for Linux, Windows and MacOS.

For instructions on how to use the Docker image and making the setup even easier using docker-compose, please check out the dedicated GitHub repository.

Build and run

Option 2 is for people who either can't or won't use Docker or who already have MySQL and Tomcat running on a machine anyway. In that case, these instructions will cover everything from setting up the requirements to configuring and building Frickl.

1. Download and install JDK (8+) (or OpenJDK), Tomcat (8+), MySQL (5.8+), Ant (1.10.5+) and NPM (6.9.0+)
   1. Set up a Tomcat user using the official documentation. The user requires at least the manager-script role.
   2. Set up a database called frickl in MySQL and generate a user with all permissions for this database. You can refer to the official documentation for this.
   3. Make sure the JDK and Ant are added to the PATH.
   4. Start both MySQL and Tomcat.
2. Clone both frickl-web and frickl-web-server onto your machine.
3. Configure Frickl Server
   1. Rename build.template.properties to build.properties.
   2. Set Tomcat properties using the Tomcat username and password chosen earlier.
   3. Set MySQL properties using the MySQL username and password chosen earlier.
   4. Set base.path to the directory containing your images.
4. Configure Frickl
   1. Create a .env file in the root of the frickl-web folder.
   2. Add VUE_APP_BASE_URL=/frickl/api/ to the file. frickl should reflect whatever you chose as the deploy.name in the build.properties of the previous step.
5. Build Frickl
   1. In the root of the frickl-web folder, run npm i then npm run build.
   2. Copy the dist folder into frickl-web-server/web so that you get frickl-web-server/web/dist.
6. Build Frickl Server
   1. In the root of the frickl-web-server folder, run ant deploy.
7. Check your installation by navigating to Frickl on Tomcat. It may be http://localhost:8080/frickl, but it'll depend on your configuration.
8. Success.

Please note, that the import process of your images will take some time. Depending on the size of your collection and the transfer speed of the medium they're stored on, this can take a few hours. The loading indicator at the top of the Frickl website indicates whether the import is still running. This process is only done once. When you add more images to your folder, Frickl will only pick them up when Tomcat is restarted.