GronnFalk Logo

GronnFalk Documentation

The simple soap search.

GronnFalk is an open-source, privacy-focused metasearch engine built for a simple and independent search experience.

GitHub Repository

This documentation website is open source too. Anyone can edit this page and contribute improvements.

Docker Supported Render Supported Railway Supported PHP Compatible

Contents

About GronnFalk

GronnFalk was founded on August 14, 2026, inspired by a bar of soap whose texture resembled the shape of the project's logo.

GronnFalk is a metasearch engine. It retrieves results from other search sources instead of maintaining its own web index.

GronnFalk is not a fork of SearXNG.

The name is inspired by Norwegian-style naming. In English, GronnFalk means Green Falcon.

English pronunciation: GRON-fawk.
Norwegian pronunciation: GROON-falk.

Search Sources

Search sources associated with GronnFalk include:

Available sources depend on the instance configuration.

GronnFalk Instances

Try one of these GronnFalk instances:

Find more instances or learn how to create your own on the GronnFalk Instances website .

Installation

You can deploy GronnFalk using Linux, Docker, Render, or Railway. GitHub Pages can host the static frontend.

Get the GronnFalk source code

Linux Installation

Requirements:

1. Install the required software

On Ubuntu or Linux Mint:

sudo apt update
sudo apt install git nodejs npm php

2. Download GronnFalk

git clone https://github.com/LiamProsser77/gronnfalk.git
cd gronnfalk

3. Install Node.js dependencies

npm install

4. Start the API

npm start

This command requires the repository's package.json to define a working start script.

5. Start a static frontend server

python3 -m http.server 8080

Open http://localhost:8080.

Configure the frontend to use the correct API URL.

PHP

PHP can serve dynamic web pages and run PHP-based backends. Installing PHP does not automatically convert the existing Node.js API into PHP.

Run a PHP website locally

If your instance contains an index.php file, run: 

php -S localhost:8080

Open http://localhost:8080.

For production, configure a suitable PHP server or Docker image. If your instance still uses the Node.js API, that API must also be running.

Docker Installation

Docker Supported

Docker lets you package and run an instance in a container.

GronnFalk Docker Repository

Requirements

1. Download GronnFalk

git clone https://github.com/LiamProsser77/gronnfalk.git
cd gronnfalk

2. Build and start the instance

docker compose up -d --build

If the repository includes a suitable Docker Compose file and maps port 8080, open: 

http://localhost:8080

3. Stop the instance

docker compose down

4. Update the instance

git pull
docker compose up -d --build

The Dockerfile describes how to build the container image. A docker-compose.yml file can configure and start the services. The files and required settings must exist for these commands to work.

Create a Render Instance

Deploy to Render

Render Supported

Instructions

  1. Create an account at Render.
  2. Connect your GitHub account.
  3. Select the GronnFalk repository.
  4. Create a new Web Service, or use the deploy link above.
  5. Select Docker if you want to build using the repository's Dockerfile.
  6. Configure environment variables and the service port as needed.
  7. Start the deployment.
  8. Wait for the build to finish.
  9. Open the URL provided by Render.

Make sure the deployment uses a supported runtime and the correct start command. For PHP, configure a compatible PHP runtime or Docker image. For the Node.js API, use the appropriate Node.js command.

Render free services may sleep when idle, depending on the service type and current plan.

Create a Railway Instance

Railway Supported

Open Railway

Instructions

  1. Create a Railway account.
  2. Create a new project.
  3. Choose deployment from a GitHub repository.
  4. Select LiamProsser77/gronnfalk.
  5. Configure the deployment to use the Dockerfile if desired.
  6. Configure the required environment variables and port.
  7. Deploy the service.
  8. Open the service's networking settings.
  9. Generate a public domain.
  10. Visit your new instance.

For PHP, use a compatible PHP runtime or Docker image. For the Node.js API, configure the appropriate start command and settings.

Create a GitHub Pages Instance

GitHub Pages hosts static HTML, CSS, JavaScript, and image files. It does not run PHP or a Node.js backend.

  1. Fork the GronnFalk repository.
  2. Open the repository's Settings.
  3. Select Pages.
  4. Choose deployment from a branch.
  5. Select the main branch and the correct folder.
  6. Save the settings.
  7. Wait for the website to publish.

Typical website address:

https://YOUR-USERNAME.github.io/gronnfalk/

Replace YOUR-USERNAME with your GitHub username. Configure the frontend to use a working API hosted separately.

API

GronnFalk API

Example search route:

/search?q=dog

Check the backend source code for the current routes, response formats, and configuration.

Privacy

Self-hosting provides more control, but actual privacy depends on the instance configuration and the providers used.

Contributing

Anyone can help improve GronnFalk by reporting bugs, suggesting features, improving documentation, or submitting code changes.

Report an issue

View pull requests

Community

Join the GronnFalk Matrix room

Visit the GronnFalk Instances website

License

GronnFalk is licensed under the Apache License 2.0.

Read the Apache License 2.0

View the GronnFalk license file

This documentation website is open source too. You can edit and improve it through GitHub.

GronnFalk — The simple soap search.