flame

Api

Keterangan

Flame adalah halaman awal yang dihosting sendiri untuk server Anda. Desainnya (sangat) terinspirasi oleh SUI. Flame sangat mudah diatur dan digunakan. Dengan editor bawaan, Anda dapat mengatur hub aplikasi Anda sendiri dalam waktu singkat - tidak perlu mengedit file.

Fungsionalitas

• Buat, perbarui, hapus aplikasi dan bookmark Anda langsung dari aplikasi menggunakan editor GUI bawaan
• ? Sematkan item favorit Anda ke layar beranda untuk akses cepat dan mudah
• ? Bilah pencarian terintegrasi dengan pemfilteran lokal, 11 penyedia pencarian web dan kemampuan untuk menambahkan milik Anda sendiri
• ? Sistem autentikasi untuk melindungi pengaturan, aplikasi, dan bookmark Anda
• ? Lusinan opsi untuk menyesuaikan antarmuka Flame dengan kebutuhan Anda, termasuk dukungan untuk CSS khusus, 15 tema warna bawaan, dan pembuat tema khusus
• ☀️ Widget cuaca dengan suhu saat ini, cakupan awan, dan status cuaca animasi
• ? Integrasi Docker untuk secara otomatis memilih dan menambahkan aplikasi berdasarkan labelnya

Instalasi

Dengan Docker (disarankan)

Tautan Hub Docker

docker pull pawelmalak/flame

# for ARM architecture (e.g. RaspberryPi)
docker pull pawelmalak/flame:multiarch

# installing specific version
docker pull pawelmalak/flame:2.0.0

Penyebaran

 # run container
docker run -p 5005:5005 -v /path/to/data:/app/data -e PASSWORD=flame_password pawelmalak/flame

Membangun gambar

 # build image for amd64 only
docker build -t flame -f .docker/Dockerfile .

# build 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 . 

Docker-Tulis

 version : ' 3.6 '

services :
  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 

Rahasia Docker

Semua variabel lingkungan dapat ditimpa dengan menambahkan _FILE ke nilai variabel. Misalnya, Anda dapat menggunakan PASSWORD_FILE untuk melewati rahasia buruh pelabuhan, bukan PASSWORD . Jika PASSWORD dan PASSWORD_FILE disetel, rahasia buruh pelabuhan akan diutamakan.

 # ./secrets/flame_password
my_custom_secret_password_123

# ./docker-compose.yml
secrets:
  password:
    file: ./secrets/flame_password

perancah

 # use skaffold
skaffold dev

Tanpa Docker

Ikuti instruksi dari wiki: Instalasi tanpa Docker

Perkembangan

Teknologi

• Bagian belakang
  • Node.js + Ekspres
  • Sekuel ORM + SQLite
• Bagian depan
  • Bereaksi
  • reduks
  • skrip ketikan
• Penyebaran
  • Buruh pelabuhan
  • Kubernet

Menciptakan lingkungan pengembang

 # clone repository
git clone https://github.com/pawelmalak/flame
cd flame

# run only once
npm run dev-init

# start backend and frontend development servers
npm run dev

Tangkapan layar

Penggunaan

Otentikasi

Kunjungi wiki proyek untuk membaca lebih lanjut tentang autentikasi

Bilah pencarian

Mencari

Pengaturan pencarian default adalah mencari di semua aplikasi dan bookmark Anda. Jika Anda ingin mencari menggunakan mesin pencari tertentu, Anda perlu mengetikkan permintaan pencarian Anda dengan awalan yang dipilih. Misalnya, untuk mencari "apa itu buruh pelabuhan" menggunakan pencarian Google, Anda harus mengetik: /g what is docker .

Untuk daftar mesin pencari yang didukung, pintasan, dan lebih banyak lagi tentang fungsi pencarian, kunjungi wiki proyek.

Menyiapkan modul cuaca

1. Dapatkan Kunci API dari Weather API.

   Paket gratis memungkinkan 1 juta panggilan per bulan. Flame menghasilkan kurang dari 3 ribu panggilan API per bulan.

2. Dapatkan lintang/bujur untuk lokasi Anda. Anda bisa mendapatkannya dari latlong.net.
3. Masukkan dan simpan data. Widget cuaca sekarang akan diperbarui dan akan terlihat di halaman Beranda.

Integrasi buruh pelabuhan

Untuk menggunakan integrasi Docker, setiap container harus memiliki label berikut:

 labels :
  - flame.type=application # "app" works too
  - flame.name=My container
  - flame.url=https://example.com
  - flame.icon=icon-name # optional, default is "docker"
# - flame.icon=custom to make changes in app. ie: custom icon upload

Opsi "Gunakan Docker API" harus diaktifkan agar ini berfungsi. Anda dapat menemukannya di Pengaturan> Docker

Anda juga dapat mengatur aplikasi berbeda dalam label yang sama dengan menambahkan ; antara masing-masing.

 labels :
  - flame.type=application
  - flame.name=First App;Second App
  - flame.url=https://example1.com;https://example2.com
  - flame.icon=icon-name1;icon-name2

Jika Anda ingin menggunakan host buruh pelabuhan jarak jauh, ikuti petunjuk berikut di host:

• Buka file /lib/systemd/system/docker.service , cari ExecStart dan edit nilainya

 ExecStart=/usr/bin/dockerd -H tcp://0.0.0.0:${PORT} -H unix:///var/run/docker.sock

Perintah di atas akan mengikat server mesin buruh pelabuhan ke soket Unix serta port TCP pilihan Anda. “0.0.0.0” berarti mesin buruh pelabuhan menerima koneksi dari semua alamat IP.

• Mulai ulang daemon dan layanan Docker

sudo systemctl daemon-reload
sudo service docker restart

• Uji apakah itu berfungsi

curl http:// ${IP} : ${PORT} /version

Integrasi Kubernetes

Untuk menggunakan integrasi Kubernetes, setiap ingress harus memiliki anotasi berikut:

 metadata :
  annotations :
  - flame.pawelmalak/type=application # "app" works too
  - flame.pawelmalak/name=My container
  - flame.pawelmalak/url=https://example.com
  - flame.pawelmalak/icon=icon-name # optional, default is "kubernetes"

Opsi "Gunakan Kubernetes Ingress API" harus diaktifkan agar ini berfungsi. Anda dapat menemukannya di Pengaturan> Docker

Impor Bookmark HTML (Eksperimental)

• Persyaratan
  • python3
  • paket pip: Bantal, sup cantik4
• Cadangkan db.sqlite Anda sebelum menjalankan skrip!
• Masalah yang Diketahui:
  • ikon yang dihasilkan terkadang salah

pip3 install Pillow, beautifulsoup4

cd flame/.dev
python3 bookmarks_importer.py --bookmarks < path to bookmarks.html > --data < path to flame data folder >

CSS dan tema khusus

Lihat wiki proyek untuk CSS Khusus dan Tema khusus dengan CSS.