Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
Flame
Description
Flame is self-hosted startpage for your server. Its design is inspired (heavily) by SUI. Flame is very easy to setup and use. With built-in editors, it allows you to setup your very own application hub in no time - no file editing necessary.
Functionality
Installation With Docker (recommended)
docker pull pawelmalak/flameDeploymentfor ARM architecture (e.g. RaspberryPi)
docker pull pawelmalak/flame:multiarch
installing specific version
docker pull pawelmalak/flame:2.0.0
# run container docker run -p 5005:5005 -v /path/to/data:/app/data -e PASSWORD=flame_password pawelmalak/flameBuilding images
# build image for amd64 only docker build -t flame -f .docker/Dockerfile .Docker-Composebuild multiarch image for amd64, armv7 and arm64
building failed multiple times with 2GB memory usage limit so you might want to increase it
docker buildx build \ --platform linux/arm/v7,linux/arm64,linux/amd64 \ -f .docker/Dockerfile.multiarch \ -t flame:multiarch .
version: '3.6'Docker Secretsservices: flame: image: pawelmalak/flame container_name: flame volumes: - /path/to/host/data:/app/data - /var/run/docker.sock:/var/run/docker.sock # optional but required for Docker integration ports: - 5005:5005 secrets: - password # optional but required for (1) environment: - PASSWORD=flame_password - PASSWORD_FILE=/run/secrets/password # optional but required for (1) restart: unless-stopped
optional but required for Docker secrets (1)
secrets: password: file: /path/to/secrets/password
All environment variables can be overwritten by appending _FILE
to the variable value. For example, you can use PASSWORD_FILE
to pass through a docker secret instead of PASSWORD
. If both PASSWORD
and PASSWORD_FILE
are set, the docker secret will take precedent.
# ./secrets/flame_password my_custom_secret_password_123Skaffold./docker-compose.yml
secrets: password: file: ./secrets/flame_password
# use skaffold skaffold devWithout Docker
Follow instructions from wiki: Installation without Docker
Development Technology
# clone repository git clone https://github.com/pawelmalak/flame cd flameScreenshotsrun only once
npm run dev-init
start backend and frontend development servers
npm run dev
Usage Authentication
Visit project wiki to read more about authentication
Search bar Searching
The default search setting is to search through all your apps and bookmarks. If you want to search using specific search engine, you need to type your search query with selected prefix. For example, to search for "what is docker" using google search you would type: /g what is docker
.
For list of supported search engines, shortcuts and more about searching functionality visit project wiki.
Setting up weather module
Free plan allows for 1M calls per month. Flame is making less then 3K API calls per month.
Docker integration
In order to use the Docker integration, each container must have the following labels:
labels:
"Use Docker API" option must be enabled for this to work. You can find it in Settings > Docker
You can also set up different apps in the same label adding ;
between each one.
labels:
If you want to use a remote docker host follow this instructions in the host:
/lib/systemd/system/docker.service
, search for ExecStart
and edit the valueExecStart=/usr/bin/dockerd -H tcp://0.0.0.0:${PORT} -H unix:///var/run/docker.sock
The above command will bind the docker engine server to the Unix socket as well as TCP port of your choice. “0.0.0.0” means docker-engine accepts connections from all IP addresses.
sudo systemctl daemon-reload sudo service docker restart
curl http://${IP}:${PORT}/versionKubernetes integration
In order to use the Kubernetes integration, each ingress must have the following annotations:
metadata: annotations:
Import HTML Bookmarks (Experimental)"Use Kubernetes Ingress API" option must be enabled for this to work. You can find it in Settings > Docker
db.sqlite
before running script!pip3 install Pillow, beautifulsoup4
cd flame/.dev python3 bookmarks_importer.py --bookmarks <path to bookmarks.html> --data <path to flame data folder> Custom CSS and themes
See project wiki for Custom CSS and Custom theme with CSS.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.