Looksyk

A simple personal knowledge platform with a focus on clean markdown files, simple queries and a journal.

---

Project maintained by SebastianRzk Hosted on GitHub Pages — Theme by mattgraham

Installation

Table of Contents

This page

• Run Looksyk
  • Arch Linux / AUR
  • Arch Linux / PKGBUILD
  • Production Build / Manual Installation
  • Running different looksyk graphs at the same time (with different ports)

Further Reading

• Overview
• idea and technical concept
• Install + Run
• Migrate Your Existing Logseq Graph
• Configuration and Usage
• Development Guide and Contribution Guidelines
• Changelog

Run Looksyk

Operation System	Installation Method	Status
Arch Linux	AUR	✅ Installation Guide
Arch Linux	PKGBUILD	✅ Installation Guide
Linux (any)	manual build	✅ Installation Guide
Linux, Windows, Mac	docker / docker compose	✅ Installation Guide
Windows native	manual build *)	untested / not working out of the box *)
Mac native	manual build *)	untested / not working out of the box *)

*) The application is programmed to be platform independent, but the build script and the installation process are not yet implemented on Windows and Mac. Mainly because I have no knowledge of packaging for Windows and Mac, and because I don’t have a test environment. If you want to help, please create an issue or a pull request.

Arch Linux / AUR

You can install Looksyk from the AUR. The package is called looksyk-desktop.

You can run the application with the command looksyk.

Arch Linux / PKGBUILD

You can build the application with the PKGBUILD. Run makepkg and install the package with pacman -U ./looksyk-desktop-<version>.tar.zst.

You can run the application with the command looksyk.

Docker / docker-compose

The repository contains two docker-compose.yml’s:

• docker-compose.yml start the app with a prebuild image from docker-hub
• docker-compose.local-build.yml build the app locally

Just run docker compose up -d to start Looksyk and visit with Chrome / Chromium the URL http://localhost:11000.

Production Build / Manual Installation

1. Run the script bash build.sh (this will build the frontend and backend, and requires npm and cargo)
2. The application is now in the target folder
3. (Optional) Create a shortcut icon sh create_desktop_shortcut.sh
4. Start the application. Use the created shortcut or run ./application-wrapper/looksyk in the target folder. You can instrument the application with the arguments --port and --graph-location to change the port and the graph location. With the argument --devtools true the electron devtools are opened as default.
5. The application is now available at http://localhost:11000 (or the configured port)

Running different looksyk graphs at the same time (with different ports)

You can use the create_desktop_shortcut.sh script to create a shortcut with a different port and graph location. Or you can run the application with the arguments --port and --graph-location manually.

Known issues with building the application-wrapper

• electron forge is used to build the application-wrapper. Sometimes it has incompatibilities with the current up-to-date node version. If you encounter problems, try to downgrade your node to an older minor-version.

Are you having problems installing or setting up? Create an issue!

Or would you like to improve the documentation or provide alternative installation methods? Make a pull request.