Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexbelgium authored May 22, 2024
1 parent 8d618d0 commit ef73765
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions birdnet-pi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ BIRDSONGS_FOLDER: folder to store birdsongs file # It should be an ssd if you wa
BIRDS_ONLINE_INFO: uses either allaboutbird (US birds in english) or ebird (universal and translated) to provide online information
SPECIES_CONVERTER: if yes, you need to put in the file /config/convert_species_list.txt the list of species you want to convert (example : Falco subbuteo_Faucon hobereau;Falco tinnunculus_Faucon Crécerelle). It will convert on the fly the specie when detected
TZ: Etc/UTC specify a timezone to use, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
ssl: true/false
certfile: fullchain.pem #ssl certificate, must be located in /ssl. Generated by let's encrypt addon ; but you can also use yours
keyfile: privkey.pem #sslkeyfile, must be located in /ssl. Generated by let's encrypt addon ; but you can also use yours.
pi_password: set the user password to access the web terminal
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
Expand Down Expand Up @@ -93,7 +90,7 @@ Further informations : https://wander.ingstar.com/projects/birdnetpi.html

Option 1 : Install let's encrypt addon, generate certificates. They are by default certfile.pem and keyfile.pem stored in /ssl. Just enable ssl from the addon option and it will work.

Option 2 : Use caddy's default ssl but then it requires the external port 80 or 443 to be mapped
Option 2 : enable port 80, define your BirdNET-Pi URL as https. Certificate will be automatically generated by caddy

## Common issues

Expand Down

0 comments on commit ef73765

Please sign in to comment.