To deploy a new Find instance, as a static website.
For more customization, see the development documentation.
There are diverse possibilities to deploy a new instance with a custom
Find, generally it will need the correct values for the I4K_FIND_URL
environment variable, https://example.org/my-find. As reference,
check the different CI/CD workflow recipes.
The recommended method is to use a CI/CD recipe to deploy a custom instance, to a custom server (or pages like the default insance). That way it regroups the code, the infrastructure that deploys it and the server that hosts it together.
Because the code of Find has no build pipeline, deploying a new
instance of Find should be as simple as copying the entire /find
folder (this repo) on a web server.
For a "clean deployment", it is better to copy the required files, into a new folder. See the CI/CD recipes references, which automate this process by listing the required steps and commands.
Makes a fork of the project, and deploy to a "static pages provider"
connected with the git repo. There is no build step, and the
project's root folder is . for the current proejct folder (or /
depending on the provider).
- fork this repository
- enable "pages from actions" in the settings
- customize the
I4K_FIND_URLenv var (it will try to default to the github pages deployment URL) - run the "static.yml" workflow
- visit the fork's github page
- fork this repository on gitlab
- it should use the
pagesjob/pipeline, that will deploy a new instance
Gitlab offfer "private pages", so a page could be accessed only by users who are logged in to the repo
Can run on localhost:<port> on any machine, with the dev server
(though maybe something more efficient could be nice).
Can be served from a "private local machine" (ex: unused phone over 4g, or raspi), runnin a wireguard VPN or private Tailscale Tailnet.
That way requests should never leave the user network, until resolved by Find to a URL that the browser can resolve