Initial public release of birdwatch-relay
This commit is contained in:
LOrignal_GaZzz
commit
c176f2ad24
17 changed files with 2025 additions and 0 deletions
29
.dockerignore
Normal file
29
.dockerignore
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
.git
|
||||||
|
.gitignore
|
||||||
|
.dockerignore
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
firebase-key.json
|
||||||
|
*firebase-adminsdk*.json
|
||||||
|
serviceAccountKey.json
|
||||||
|
*-credentials.json
|
||||||
|
data/
|
||||||
|
*.db
|
||||||
|
*.db-shm
|
||||||
|
*.db-wal
|
||||||
|
docker-compose.yml
|
||||||
|
docker-compose.yml.bak
|
||||||
|
SECURITY-AUDIT.md
|
||||||
|
README.md
|
||||||
|
*.pem
|
||||||
|
*.key
|
||||||
|
secrets/
|
||||||
|
/out/
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
*.log
|
||||||
|
*.bak
|
||||||
|
*.bak[0-9]
|
||||||
|
*.bak[0-9][0-9]
|
||||||
16
.env.example
Normal file
16
.env.example
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# Copy to .env. Generate the pairing code with:
|
||||||
|
# openssl rand -hex 3 # 6 hex chars
|
||||||
|
|
||||||
|
# Pairing code — phone sends this in the Authorization header on first
|
||||||
|
# registration. You also type it once into the BirdWatch app.
|
||||||
|
RELAY_PAIRING_CODE=replace-me-with-6-hex-chars
|
||||||
|
|
||||||
|
# Frigate connection details. The relay subscribes to /ws as a long-lived
|
||||||
|
# event consumer. URL should be the same one Frigate's web UI lives at,
|
||||||
|
# from this machine's perspective (typically http://localhost:5000).
|
||||||
|
FRIGATE_URL=http://localhost:5000
|
||||||
|
|
||||||
|
# Frigate API user + password. Leave both blank if Frigate has auth disabled.
|
||||||
|
# Recommended: create a dedicated Frigate user (e.g. "birdwatch-relay").
|
||||||
|
FRIGATE_USER=
|
||||||
|
FRIGATE_PASSWORD=
|
||||||
51
.gitignore
vendored
Normal file
51
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
/data/
|
||||||
|
*.db
|
||||||
|
*.db-shm
|
||||||
|
*.db-wal
|
||||||
|
|
||||||
|
# Firebase service-account keys (the file format actually downloaded from
|
||||||
|
# Firebase Console looks like `<project>-firebase-adminsdk-<svc>-<hash>.json`).
|
||||||
|
firebase-key.json
|
||||||
|
*firebase-adminsdk*.json
|
||||||
|
serviceAccountKey.json
|
||||||
|
*-credentials.json
|
||||||
|
|
||||||
|
# Customer secrets / runtime config
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
!.env.example
|
||||||
|
docker-compose.yml
|
||||||
|
docker-compose.yml.bak
|
||||||
|
secrets/
|
||||||
|
|
||||||
|
# Build artifacts
|
||||||
|
*.exe
|
||||||
|
/out/
|
||||||
|
relay
|
||||||
|
relay-*
|
||||||
|
|
||||||
|
# TLS / private keys (never commit)
|
||||||
|
*.pem
|
||||||
|
*.key
|
||||||
|
|
||||||
|
# Internal docs (audit reports etc., keep private until released)
|
||||||
|
SECURITY-AUDIT.md
|
||||||
|
|
||||||
|
# Editor / IDE
|
||||||
|
.idea/
|
||||||
|
.vscode/
|
||||||
|
*.iml
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
|
||||||
|
# OS artifacts
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Personal backups (the .bak* convention used while iterating)
|
||||||
|
*.bak
|
||||||
|
*.bak[0-9]
|
||||||
|
*.bak[0-9][0-9]
|
||||||
19
Dockerfile
Normal file
19
Dockerfile
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# syntax=docker/dockerfile:1
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
FROM golang:1.22-alpine AS build
|
||||||
|
WORKDIR /src
|
||||||
|
COPY . .
|
||||||
|
# go mod tidy resolves dependencies from source imports — no go.sum needed at
|
||||||
|
# repo root for first-time users running `docker compose build`.
|
||||||
|
RUN go mod tidy && \
|
||||||
|
CGO_ENABLED=0 GOOS=linux go build \
|
||||||
|
-ldflags="-s -w" \
|
||||||
|
-o /out/birdwatch-relay \
|
||||||
|
.
|
||||||
|
|
||||||
|
FROM gcr.io/distroless/static-debian12:nonroot
|
||||||
|
COPY --from=build /out/birdwatch-relay /birdwatch-relay
|
||||||
|
USER nonroot:nonroot
|
||||||
|
EXPOSE 8080
|
||||||
|
ENTRYPOINT ["/birdwatch-relay"]
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
131
README.md
Normal file
131
README.md
Normal file
|
|
@ -0,0 +1,131 @@
|
||||||
|
# BirdWatch Relay
|
||||||
|
|
||||||
|
Self-hosted bridge between [Frigate NVR](https://frigate.video) and the BirdWatch Android app. Forwards Frigate event webhooks to your phone via Firebase Cloud Messaging, with payloads end-to-end encrypted (NaCl sealed box, X25519 + XSalsa20-Poly1305) so Google sees ciphertext only.
|
||||||
|
|
||||||
|
You run this on the same Linux machine as Frigate (your NVR). Source is AGPLv3.
|
||||||
|
|
||||||
|
## Quick install
|
||||||
|
|
||||||
|
The interactive installer asks the questions, generates the secret, writes the config, builds the image, starts the container, and prints the exact strings to paste into Frigate and the BirdWatch app.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/cyrilinait/birdwatch-relay.git
|
||||||
|
cd birdwatch-relay
|
||||||
|
./setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
The script needs Docker, Docker Compose v2, `openssl`, and `curl` — all present on a typical Frigate NVR.
|
||||||
|
|
||||||
|
You'll be asked for two things during setup:
|
||||||
|
1. The path to your Firebase service-account JSON file (instructions below if you don't have one).
|
||||||
|
2. The hostname or LAN IP your phone will reach the relay at.
|
||||||
|
|
||||||
|
That's it. The script handles the rest, then prints the URL to paste into the BirdWatch app and the webhook URL + `Authorization` header to add to Frigate's `config.yml`.
|
||||||
|
|
||||||
|
## Getting a Firebase service-account key (one time, ~5 minutes)
|
||||||
|
|
||||||
|
The relay sends pushes via Google's Firebase Cloud Messaging. You need a free Firebase project to do that. Google sees only ciphertext and a device token — they cannot read the events.
|
||||||
|
|
||||||
|
1. Open https://console.firebase.google.com
|
||||||
|
2. Click **Add project**. Name it whatever you want (e.g. `birdwatch-home`). Skip Analytics if asked.
|
||||||
|
3. Once the project loads, click the gear icon (top-left) → **Project settings**.
|
||||||
|
4. Open the **Service accounts** tab.
|
||||||
|
5. Click **Generate new private key**. A `.json` file downloads — this is the file the installer will ask for.
|
||||||
|
6. Move it to your NVR (e.g. with `scp`).
|
||||||
|
|
||||||
|
Anyone with this file can send pushes to your phones, so keep it private (the installer copies it to `./firebase-key.json` with mode 600 and the `.gitignore` excludes it).
|
||||||
|
|
||||||
|
## Running alongside an existing Frigate stack
|
||||||
|
|
||||||
|
If your Frigate is already deployed via `docker-compose.yml`, you can merge the relay into the same stack instead of running it standalone. After running `./setup.sh` once to generate `.env`, edit your existing Frigate `docker-compose.yml` and add this service block:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
birdwatch-relay:
|
||||||
|
build: /path/to/birdwatch-relay
|
||||||
|
container_name: birdwatch-relay
|
||||||
|
restart: unless-stopped
|
||||||
|
ports:
|
||||||
|
- "8080:8080"
|
||||||
|
volumes:
|
||||||
|
- /path/to/birdwatch-relay/data:/data
|
||||||
|
- /path/to/birdwatch-relay/firebase-key.json:/secrets/firebase-key.json:ro
|
||||||
|
environment:
|
||||||
|
RELAY_FIREBASE_KEY_PATH: /secrets/firebase-key.json
|
||||||
|
RELAY_WEBHOOK_SECRET: ${RELAY_WEBHOOK_SECRET}
|
||||||
|
RELAY_DB_PATH: /data/relay.db
|
||||||
|
RELAY_PORT: "8080"
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `/path/to/birdwatch-relay` with the absolute path of this clone. Add `RELAY_WEBHOOK_SECRET=...` to your stack's `.env` (copy the value from `birdwatch-relay/.env`). Then `docker compose up -d`.
|
||||||
|
|
||||||
|
The advantage: one stack, one place to start/stop, the relay starts and stops with Frigate.
|
||||||
|
|
||||||
|
## What ends up where (the data picture)
|
||||||
|
|
||||||
|
| Where | What lives there |
|
||||||
|
|-------|------------------|
|
||||||
|
| Your NVR | Container, SQLite (`./data/relay.db`), Firebase key (`./firebase-key.json`), webhook secret (`./.env`). All on your hardware. |
|
||||||
|
| Your phone | The X25519 private key (Android Keystore-protected, never leaves the device). |
|
||||||
|
| Google FCM | Your phone's FCM token + the encrypted blob + delivery timestamps. No event content. |
|
||||||
|
| Anywhere else (cyrilina.it, etc.) | Nothing. There is no third-party endpoint in the data path. |
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
- `POST /v1/devices` — phones register here. Body: `{"device_id":"...", "fcm_token":"...", "public_key":"<base64-32-bytes-X25519>"}`. Returns 204.
|
||||||
|
- `POST /v1/webhook` — Frigate sends events here. `Authorization: Bearer <secret>`. Body: any JSON ≤ 64 KB. Returns 202.
|
||||||
|
- `GET /v1/health` — liveness probe. Returns `ok` / 200.
|
||||||
|
|
||||||
|
## Manual install (if you don't want to use setup.sh)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Generate a webhook secret.
|
||||||
|
openssl rand -hex 32 > /tmp/secret.txt
|
||||||
|
|
||||||
|
# 2. Place your Firebase key.
|
||||||
|
cp /path/to/your-firebase-key.json ./firebase-key.json
|
||||||
|
chmod 600 ./firebase-key.json
|
||||||
|
|
||||||
|
# 3. Write .env.
|
||||||
|
echo "RELAY_WEBHOOK_SECRET=$(cat /tmp/secret.txt)" > .env
|
||||||
|
chmod 600 .env
|
||||||
|
|
||||||
|
# 4. Copy the example compose file and adjust ports if you want.
|
||||||
|
cp docker-compose.example.yml docker-compose.yml
|
||||||
|
|
||||||
|
# 5. Build and start.
|
||||||
|
docker compose up -d --build
|
||||||
|
|
||||||
|
# 6. Verify.
|
||||||
|
curl http://localhost:8080/v1/health # should print: ok
|
||||||
|
```
|
||||||
|
|
||||||
|
Webhook URL for Frigate: `http://<this-machine>:8080/v1/webhook` with header `Authorization: Bearer <the secret from .env>`.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
**Container won't start.** `docker compose logs relay`. Most common: missing `RELAY_FIREBASE_KEY_PATH` or `RELAY_WEBHOOK_SECRET`, or the secret is shorter than 32 characters.
|
||||||
|
|
||||||
|
**Webhook returns 401.** The `Authorization: Bearer …` value Frigate is sending doesn't match `RELAY_WEBHOOK_SECRET` in `.env`. Re-paste, restart Frigate.
|
||||||
|
|
||||||
|
**Relay logs `webhook fanout sent=N` but no notification on phone.** The push reached FCM. Check the BirdWatch app has notifications enabled at the OS level, and that battery-saver mode is ON inside BirdWatch.
|
||||||
|
|
||||||
|
**Notification arrives but says "Encrypted message" / can't decrypt.** Phone's private key doesn't match the public key registered with the relay. Toggle BirdWatch's battery-saver switch off then on to re-register.
|
||||||
|
|
||||||
|
**`firebase init failed: invalid_grant`.** The Firebase service-account JSON is corrupted or wrong file. Re-download from Firebase Console → Project Settings → Service accounts.
|
||||||
|
|
||||||
|
**Re-run setup.** `./setup.sh` is idempotent. It backs up the previous `.env` and `docker-compose.yml` to `*.bak` before writing new ones.
|
||||||
|
|
||||||
|
## Security model
|
||||||
|
|
||||||
|
- **The relay holds your Firebase admin key.** If it leaks, an attacker can send pushes (but not read past notifications — those are encrypted to your phone). `.gitignore` excludes the file. Keep it off public storage.
|
||||||
|
- **The webhook secret is the only thing stopping random people on your network from sending fake events.** It's 64 hex characters by default (256 bits). Compared with constant-time comparison server-side. Rotate if exposed.
|
||||||
|
- **Distroless static container, nonroot user, no shell, no package manager.** Minimal attack surface inside the container.
|
||||||
|
- **TLS** — the relay does not terminate TLS itself. For LAN-only deployments that's fine. If you expose the relay to the public internet (e.g. so phones can receive notifications away from home Wi-Fi), put a TLS reverse proxy in front (Caddy, Traefik, nginx) and use `https://` in the BirdWatch app and Frigate.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AGPL-3.0-or-later. See [`LICENSE`](LICENSE). Source must accompany any deployment that serves users over a network — that's the AGPL difference.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
This relay is a small dedicated service. Patches welcome via PR. Before publishing changes, run the security and optimize agents per `feedback_security_optimize_before_ship.md` in the BirdWatch project memory.
|
||||||
20
docker-compose.example.yml
Normal file
20
docker-compose.example.yml
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Example deployment. Copy to docker-compose.yml, fill in the values, and put
|
||||||
|
# your Firebase service-account JSON next to this file as firebase-key.json.
|
||||||
|
services:
|
||||||
|
relay:
|
||||||
|
image: ghcr.io/cyrilinait/birdwatch-relay:latest
|
||||||
|
container_name: birdwatch-relay
|
||||||
|
restart: unless-stopped
|
||||||
|
ports:
|
||||||
|
- "8080:8080"
|
||||||
|
volumes:
|
||||||
|
- ./data:/data
|
||||||
|
- ./firebase-key.json:/secrets/firebase-key.json:ro
|
||||||
|
environment:
|
||||||
|
RELAY_FIREBASE_KEY_PATH: /secrets/firebase-key.json
|
||||||
|
RELAY_PAIRING_CODE: ${RELAY_PAIRING_CODE}
|
||||||
|
RELAY_DB_PATH: /data/relay.db
|
||||||
|
RELAY_PORT: "8080"
|
||||||
|
FRIGATE_URL: ${FRIGATE_URL}
|
||||||
|
FRIGATE_USER: ${FRIGATE_USER}
|
||||||
|
FRIGATE_PASSWORD: ${FRIGATE_PASSWORD}
|
||||||
11
go.mod
Normal file
11
go.mod
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
module github.com/cyrilinait/birdwatch-relay
|
||||||
|
|
||||||
|
go 1.22
|
||||||
|
|
||||||
|
require (
|
||||||
|
firebase.google.com/go/v4 v4.14.1
|
||||||
|
github.com/gorilla/websocket v1.5.1
|
||||||
|
golang.org/x/crypto v0.21.0
|
||||||
|
google.golang.org/api v0.171.0
|
||||||
|
modernc.org/sqlite v1.29.5
|
||||||
|
)
|
||||||
47
internal/config/config.go
Normal file
47
internal/config/config.go
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Config struct {
|
||||||
|
Port string
|
||||||
|
DBPath string
|
||||||
|
FirebaseKeyPath string
|
||||||
|
PairingCode string
|
||||||
|
FrigateURL string
|
||||||
|
FrigateUser string
|
||||||
|
FrigatePassword string
|
||||||
|
}
|
||||||
|
|
||||||
|
func Load() (*Config, error) {
|
||||||
|
c := &Config{
|
||||||
|
Port: getenv("RELAY_PORT", "8080"),
|
||||||
|
DBPath: getenv("RELAY_DB_PATH", "/data/relay.db"),
|
||||||
|
FirebaseKeyPath: os.Getenv("RELAY_FIREBASE_KEY_PATH"),
|
||||||
|
PairingCode: os.Getenv("RELAY_PAIRING_CODE"),
|
||||||
|
FrigateURL: os.Getenv("FRIGATE_URL"),
|
||||||
|
FrigateUser: os.Getenv("FRIGATE_USER"),
|
||||||
|
FrigatePassword: os.Getenv("FRIGATE_PASSWORD"),
|
||||||
|
}
|
||||||
|
if c.FirebaseKeyPath == "" {
|
||||||
|
return nil, errors.New("RELAY_FIREBASE_KEY_PATH is required")
|
||||||
|
}
|
||||||
|
if c.PairingCode == "" || len(c.PairingCode) < 6 {
|
||||||
|
return nil, errors.New("RELAY_PAIRING_CODE must be at least 6 chars (use: openssl rand -hex 3)")
|
||||||
|
}
|
||||||
|
if c.FrigateURL == "" {
|
||||||
|
return nil, errors.New("FRIGATE_URL is required (e.g. http://localhost:5000)")
|
||||||
|
}
|
||||||
|
// FRIGATE_USER + FRIGATE_PASSWORD optional — empty means Frigate has auth disabled.
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func getenv(key, fallback string) string {
|
||||||
|
if v := os.Getenv(key); v != "" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
31
internal/crypto/sealedbox.go
Normal file
31
internal/crypto/sealedbox.go
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
//
|
||||||
|
// Sealed-box encryption: anonymous public-key encryption. Anyone holding the
|
||||||
|
// recipient's public key can produce a ciphertext; only the holder of the
|
||||||
|
// recipient's private key can decrypt it. Built on X25519 + XSalsa20-Poly1305.
|
||||||
|
//
|
||||||
|
// Wire format: ephemeral_pubkey (32 bytes) || box_ciphertext.
|
||||||
|
// See https://pkg.go.dev/golang.org/x/crypto/nacl/box#SealAnonymous.
|
||||||
|
//
|
||||||
|
// On the Android side, the matching primitive is libsodium's
|
||||||
|
// crypto_box_seal / crypto_box_seal_open. Lazysodium-android is a
|
||||||
|
// drop-in dependency.
|
||||||
|
|
||||||
|
package crypto
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"errors"
|
||||||
|
|
||||||
|
"golang.org/x/crypto/nacl/box"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Seal encrypts plaintext to recipientPub. recipientPub must be 32 bytes (X25519).
|
||||||
|
func Seal(plaintext []byte, recipientPub []byte) ([]byte, error) {
|
||||||
|
if len(recipientPub) != 32 {
|
||||||
|
return nil, errors.New("recipient public key must be 32 bytes")
|
||||||
|
}
|
||||||
|
var pub [32]byte
|
||||||
|
copy(pub[:], recipientPub)
|
||||||
|
return box.SealAnonymous(nil, plaintext, &pub, rand.Reader)
|
||||||
|
}
|
||||||
44
internal/fcm/sender.go
Normal file
44
internal/fcm/sender.go
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
package fcm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/base64"
|
||||||
|
|
||||||
|
firebase "firebase.google.com/go/v4"
|
||||||
|
"firebase.google.com/go/v4/messaging"
|
||||||
|
"google.golang.org/api/option"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Sender struct {
|
||||||
|
client *messaging.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func New(ctx context.Context, keyPath string) (*Sender, error) {
|
||||||
|
app, err := firebase.NewApp(ctx, nil, option.WithCredentialsFile(keyPath))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
mc, err := app.Messaging(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &Sender{client: mc}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendCiphertext delivers a ciphertext to a single FCM token as a data-only
|
||||||
|
// push (no `notification` field) so the phone decrypts and renders locally —
|
||||||
|
// Google never sees plaintext.
|
||||||
|
func (s *Sender) SendCiphertext(ctx context.Context, fcmToken string, ciphertext []byte) error {
|
||||||
|
msg := &messaging.Message{
|
||||||
|
Token: fcmToken,
|
||||||
|
Data: map[string]string{
|
||||||
|
"ciphertext": base64.StdEncoding.EncodeToString(ciphertext),
|
||||||
|
},
|
||||||
|
Android: &messaging.AndroidConfig{
|
||||||
|
Priority: "high",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_, err := s.client.Send(ctx, msg)
|
||||||
|
return err
|
||||||
|
}
|
||||||
227
internal/frigate/client.go
Normal file
227
internal/frigate/client.go
Normal file
|
|
@ -0,0 +1,227 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
//
|
||||||
|
// Client subscribes to Frigate's /ws WebSocket as a long-lived event consumer.
|
||||||
|
// The wire format is taken verbatim from BirdWatch's existing
|
||||||
|
// EventWebSocketService: login via POST /api/login (Gson body
|
||||||
|
// `{"user":"...","password":"..."}`), then dial /ws with the resulting cookies,
|
||||||
|
// and parse incoming JSON frames whose `topic` field is "events". The frame's
|
||||||
|
// `payload` field is itself a JSON-encoded string; we forward it as-is to the
|
||||||
|
// handler. Reconnect is exponential backoff capped at 5 minutes — same as the
|
||||||
|
// Android client, with the same heartbeat (20s ping) so connection drops are
|
||||||
|
// detected promptly.
|
||||||
|
|
||||||
|
package frigate
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"net/http/cookiejar"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gorilla/websocket"
|
||||||
|
)
|
||||||
|
|
||||||
|
type EventHandler func(payload []byte)
|
||||||
|
|
||||||
|
type Client struct {
|
||||||
|
baseURL string
|
||||||
|
username string
|
||||||
|
password string
|
||||||
|
handler EventHandler
|
||||||
|
|
||||||
|
httpClient *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
// frame is the outer envelope Frigate sends on /ws.
|
||||||
|
type frame struct {
|
||||||
|
Topic string `json:"topic"`
|
||||||
|
Payload string `json:"payload"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewClient(baseURL, username, password string, handler EventHandler) (*Client, error) {
|
||||||
|
jar, err := cookiejar.New(nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &Client{
|
||||||
|
baseURL: strings.TrimRight(baseURL, "/"),
|
||||||
|
username: username,
|
||||||
|
password: password,
|
||||||
|
handler: handler,
|
||||||
|
httpClient: &http.Client{
|
||||||
|
Timeout: 30 * time.Second,
|
||||||
|
Jar: jar,
|
||||||
|
},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run blocks until ctx is canceled, reconnecting on every failure with
|
||||||
|
// exponential backoff (1s → 5min cap).
|
||||||
|
func (c *Client) Run(ctx context.Context) {
|
||||||
|
const (
|
||||||
|
initialBackoff = time.Second
|
||||||
|
maxBackoff = 5 * time.Minute
|
||||||
|
)
|
||||||
|
backoff := initialBackoff
|
||||||
|
for {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
err := c.runOnce(ctx)
|
||||||
|
if err == nil || ctx.Err() != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
slog.Warn("frigate connection ended, will retry",
|
||||||
|
"err", err, "next_retry_in", backoff)
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-time.After(backoff):
|
||||||
|
}
|
||||||
|
backoff *= 2
|
||||||
|
if backoff > maxBackoff {
|
||||||
|
backoff = maxBackoff
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) runOnce(ctx context.Context) error {
|
||||||
|
if err := c.login(ctx); err != nil {
|
||||||
|
return fmt.Errorf("login: %w", err)
|
||||||
|
}
|
||||||
|
return c.subscribe(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) login(ctx context.Context) error {
|
||||||
|
if c.username == "" {
|
||||||
|
// Auth-disabled Frigate. Skip login.
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
body, _ := json.Marshal(map[string]string{
|
||||||
|
"user": c.username,
|
||||||
|
"password": c.password,
|
||||||
|
})
|
||||||
|
loginURL := c.baseURL + "/api/login"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, loginURL, bytes.NewReader(body))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
resp, err := c.httpClient.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode/100 != 2 {
|
||||||
|
b, _ := io.ReadAll(resp.Body)
|
||||||
|
return fmt.Errorf("frigate login returned %d: %s", resp.StatusCode, truncate(string(b), 200))
|
||||||
|
}
|
||||||
|
slog.Info("frigate login ok", "url", loginURL)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) subscribe(ctx context.Context) error {
|
||||||
|
wsURL, err := wsURLFromBase(c.baseURL)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
headers := http.Header{}
|
||||||
|
if cookies := c.httpClient.Jar.Cookies(wsURL); len(cookies) > 0 {
|
||||||
|
var sb strings.Builder
|
||||||
|
for i, ck := range cookies {
|
||||||
|
if i > 0 {
|
||||||
|
sb.WriteString("; ")
|
||||||
|
}
|
||||||
|
sb.WriteString(ck.Name + "=" + ck.Value)
|
||||||
|
}
|
||||||
|
headers.Set("Cookie", sb.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
dialer := websocket.Dialer{HandshakeTimeout: 15 * time.Second}
|
||||||
|
conn, _, err := dialer.DialContext(ctx, wsURL.String(), headers)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("ws dial: %w", err)
|
||||||
|
}
|
||||||
|
defer conn.Close()
|
||||||
|
|
||||||
|
slog.Info("frigate ws connected", "url", wsURL.String())
|
||||||
|
|
||||||
|
// Read deadline refreshed by every pong; gorilla auto-replies to server pings.
|
||||||
|
_ = conn.SetReadDeadline(time.Now().Add(60 * time.Second))
|
||||||
|
conn.SetPongHandler(func(string) error {
|
||||||
|
return conn.SetReadDeadline(time.Now().Add(60 * time.Second))
|
||||||
|
})
|
||||||
|
|
||||||
|
// Local pinger to keep NAT/proxy paths alive.
|
||||||
|
pingerCtx, cancelPinger := context.WithCancel(ctx)
|
||||||
|
defer cancelPinger()
|
||||||
|
go func() {
|
||||||
|
ticker := time.NewTicker(20 * time.Second)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-pingerCtx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
_ = conn.WriteControl(websocket.PingMessage, nil, time.Now().Add(5*time.Second))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
for {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, msg, err := conn.ReadMessage()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("ws read: %w", err)
|
||||||
|
}
|
||||||
|
c.dispatch(msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) dispatch(raw []byte) {
|
||||||
|
var f frame
|
||||||
|
if err := json.Unmarshal(raw, &f); err != nil {
|
||||||
|
slog.Debug("ws frame unparseable, ignoring", "err", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if f.Topic != "events" {
|
||||||
|
// Frigate sends other topics (stats, etc.) — we only forward "events".
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// payload is itself a JSON-encoded string per Frigate's wire format.
|
||||||
|
c.handler([]byte(f.Payload))
|
||||||
|
}
|
||||||
|
|
||||||
|
func wsURLFromBase(base string) (*url.URL, error) {
|
||||||
|
u, err := url.Parse(base)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
switch u.Scheme {
|
||||||
|
case "http":
|
||||||
|
u.Scheme = "ws"
|
||||||
|
case "https":
|
||||||
|
u.Scheme = "wss"
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("unsupported scheme %q (want http or https)", u.Scheme)
|
||||||
|
}
|
||||||
|
u.Path = strings.TrimRight(u.Path, "/") + "/ws"
|
||||||
|
return u, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func truncate(s string, n int) string {
|
||||||
|
if len(s) <= n {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
return s[:n] + "…"
|
||||||
|
}
|
||||||
114
internal/handlers/handlers.go
Normal file
114
internal/handlers/handlers.go
Normal file
|
|
@ -0,0 +1,114 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
package handlers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/config"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/storage"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Handlers struct {
|
||||||
|
store *storage.Store
|
||||||
|
cfg *config.Config
|
||||||
|
}
|
||||||
|
|
||||||
|
func Register(mux *http.ServeMux, store *storage.Store, cfg *config.Config) {
|
||||||
|
h := &Handlers{store: store, cfg: cfg}
|
||||||
|
mux.HandleFunc("/v1/devices", h.registerDevice)
|
||||||
|
mux.HandleFunc("/v1/health", h.health)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /v1/health -----------------------------------------------------------
|
||||||
|
|
||||||
|
func (h *Handlers) health(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/plain")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("ok"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- /v1/devices ----------------------------------------------------------
|
||||||
|
|
||||||
|
type registerRequest struct {
|
||||||
|
DeviceID string `json:"device_id"`
|
||||||
|
FCMToken string `json:"fcm_token"`
|
||||||
|
PublicKey string `json:"public_key"` // base64 X25519, 32 bytes raw
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *Handlers) registerDevice(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !h.checkBearer(r, h.cfg.PairingCode) {
|
||||||
|
http.Error(w, "unauthorized — invalid pairing code", http.StatusUnauthorized)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var req registerRequest
|
||||||
|
if err := json.NewDecoder(http.MaxBytesReader(w, r.Body, 4096)).Decode(&req); err != nil {
|
||||||
|
http.Error(w, "invalid json", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if req.DeviceID == "" || req.FCMToken == "" || req.PublicKey == "" {
|
||||||
|
http.Error(w, "missing fields", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
pub, err := base64.StdEncoding.DecodeString(req.PublicKey)
|
||||||
|
if err != nil || len(pub) != 32 {
|
||||||
|
http.Error(w, "public_key must be base64-encoded 32-byte X25519", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Anti-hijack: existing device_id must keep the same public key.
|
||||||
|
existing, getErr := h.store.Get(req.DeviceID)
|
||||||
|
switch {
|
||||||
|
case getErr == nil:
|
||||||
|
if !bytes.Equal(existing.PublicKey, pub) {
|
||||||
|
http.Error(w,
|
||||||
|
"device_id already registered with a different public key — operator must delete the existing record to allow re-registration",
|
||||||
|
http.StatusConflict)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
case errors.Is(getErr, storage.ErrNotFound):
|
||||||
|
// fall through; new device.
|
||||||
|
default:
|
||||||
|
slog.Error("store get failed", "err", getErr, "device_id", req.DeviceID)
|
||||||
|
http.Error(w, "storage error", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
now := time.Now().UTC()
|
||||||
|
if err := h.store.Upsert(storage.Device{
|
||||||
|
ID: req.DeviceID,
|
||||||
|
FCMToken: req.FCMToken,
|
||||||
|
PublicKey: pub,
|
||||||
|
CreatedAt: now,
|
||||||
|
LastSeenAt: now,
|
||||||
|
}); err != nil {
|
||||||
|
slog.Error("device upsert failed", "err", err, "device_id", req.DeviceID)
|
||||||
|
http.Error(w, "storage error", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *Handlers) checkBearer(r *http.Request, want string) bool {
|
||||||
|
got := r.Header.Get("Authorization")
|
||||||
|
const prefix = "Bearer "
|
||||||
|
if !strings.HasPrefix(got, prefix) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
have := strings.TrimPrefix(got, prefix)
|
||||||
|
if len(have) != len(want) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return subtle.ConstantTimeCompare([]byte(have), []byte(want)) == 1
|
||||||
|
}
|
||||||
57
internal/notify/dispatcher.go
Normal file
57
internal/notify/dispatcher.go
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
//
|
||||||
|
// Dispatcher fan-outs an event payload to every registered device, encrypting
|
||||||
|
// the payload to each device's X25519 public key (NaCl sealed box) and sending
|
||||||
|
// the ciphertext via Firebase Cloud Messaging.
|
||||||
|
|
||||||
|
package notify
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/crypto"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/fcm"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/storage"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Dispatcher struct {
|
||||||
|
store *storage.Store
|
||||||
|
sender *fcm.Sender
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewDispatcher(store *storage.Store, sender *fcm.Sender) *Dispatcher {
|
||||||
|
return &Dispatcher{store: store, sender: sender}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send fans the payload out to every registered device. The payload is sealed
|
||||||
|
// to each device's public key independently — Google FCM only ever sees
|
||||||
|
// ciphertext + the device token. Errors per device are logged but do not stop
|
||||||
|
// the rest of the fanout.
|
||||||
|
func (d *Dispatcher) Send(ctx context.Context, payload []byte) {
|
||||||
|
devices, err := d.store.ListAll()
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("dispatcher: list devices failed", "err", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(devices) == 0 {
|
||||||
|
slog.Debug("dispatcher: no registered devices, dropping event")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var sent, failed int
|
||||||
|
for _, dev := range devices {
|
||||||
|
ct, err := crypto.Seal(payload, dev.PublicKey)
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("dispatcher: seal failed", "err", err, "device_id", dev.ID)
|
||||||
|
failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := d.sender.SendCiphertext(ctx, dev.FCMToken, ct); err != nil {
|
||||||
|
slog.Warn("dispatcher: fcm send failed", "err", err, "device_id", dev.ID)
|
||||||
|
failed++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
sent++
|
||||||
|
}
|
||||||
|
slog.Info("dispatcher fanout", "sent", sent, "failed", failed, "total", len(devices))
|
||||||
|
}
|
||||||
118
internal/storage/sqlite.go
Normal file
118
internal/storage/sqlite.go
Normal file
|
|
@ -0,0 +1,118 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
package storage
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
_ "modernc.org/sqlite"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotFound is returned by Get when no device row matches the given id.
|
||||||
|
var ErrNotFound = errors.New("device not found")
|
||||||
|
|
||||||
|
type Device struct {
|
||||||
|
ID string
|
||||||
|
FCMToken string
|
||||||
|
PublicKey []byte // 32-byte X25519
|
||||||
|
CreatedAt time.Time
|
||||||
|
LastSeenAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type Store struct {
|
||||||
|
db *sql.DB
|
||||||
|
}
|
||||||
|
|
||||||
|
func Open(path string) (*Store, error) {
|
||||||
|
db, err := sql.Open("sqlite", path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := db.Ping(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, err := db.Exec(schema); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &Store{db: db}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
const schema = `
|
||||||
|
CREATE TABLE IF NOT EXISTS devices (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
fcm_token TEXT NOT NULL,
|
||||||
|
public_key BLOB NOT NULL,
|
||||||
|
created_at INTEGER NOT NULL,
|
||||||
|
last_seen_at INTEGER NOT NULL
|
||||||
|
);
|
||||||
|
`
|
||||||
|
|
||||||
|
// Get returns the device row for id, or ErrNotFound if no row exists.
|
||||||
|
func (s *Store) Get(id string) (*Device, error) {
|
||||||
|
var d Device
|
||||||
|
var created, lastSeen int64
|
||||||
|
err := s.db.QueryRow(
|
||||||
|
`SELECT id, fcm_token, public_key, created_at, last_seen_at FROM devices WHERE id = ?`,
|
||||||
|
id,
|
||||||
|
).Scan(&d.ID, &d.FCMToken, &d.PublicKey, &created, &lastSeen)
|
||||||
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
d.CreatedAt = time.Unix(created, 0)
|
||||||
|
d.LastSeenAt = time.Unix(lastSeen, 0)
|
||||||
|
return &d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Store) Upsert(d Device) error {
|
||||||
|
_, err := s.db.Exec(
|
||||||
|
`INSERT INTO devices (id, fcm_token, public_key, created_at, last_seen_at)
|
||||||
|
VALUES (?, ?, ?, ?, ?)
|
||||||
|
ON CONFLICT(id) DO UPDATE SET
|
||||||
|
fcm_token = excluded.fcm_token,
|
||||||
|
public_key = excluded.public_key,
|
||||||
|
last_seen_at = excluded.last_seen_at`,
|
||||||
|
d.ID, d.FCMToken, d.PublicKey, d.CreatedAt.Unix(), d.LastSeenAt.Unix(),
|
||||||
|
)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Store) ListAll() ([]Device, error) {
|
||||||
|
rows, err := s.db.Query(`SELECT id, fcm_token, public_key, created_at, last_seen_at FROM devices`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var devices []Device
|
||||||
|
for rows.Next() {
|
||||||
|
var d Device
|
||||||
|
var created, lastSeen int64
|
||||||
|
if err := rows.Scan(&d.ID, &d.FCMToken, &d.PublicKey, &created, &lastSeen); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
d.CreatedAt = time.Unix(created, 0)
|
||||||
|
d.LastSeenAt = time.Unix(lastSeen, 0)
|
||||||
|
devices = append(devices, d)
|
||||||
|
}
|
||||||
|
return devices, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Store) Delete(id string) error {
|
||||||
|
res, err := s.db.Exec(`DELETE FROM devices WHERE id = ?`, id)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
n, _ := res.RowsAffected()
|
||||||
|
if n == 0 {
|
||||||
|
return ErrNotFound
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Store) Close() error {
|
||||||
|
return s.db.Close()
|
||||||
|
}
|
||||||
107
main.go
Normal file
107
main.go
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
//
|
||||||
|
// BirdWatch Relay — self-hosted, end-to-end encrypted push relay for Frigate NVR.
|
||||||
|
// Subscribes to Frigate's /ws WebSocket, encrypts each event payload with each
|
||||||
|
// registered device's X25519 public key (NaCl sealed box), and forwards the
|
||||||
|
// ciphertext via Firebase Cloud Messaging. Google FCM only ever sees ciphertext
|
||||||
|
// and a device token — never event content.
|
||||||
|
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/config"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/fcm"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/frigate"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/handlers"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/notify"
|
||||||
|
"github.com/cyrilinait/birdwatch-relay/internal/storage"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
|
||||||
|
slog.SetDefault(logger)
|
||||||
|
|
||||||
|
cfg, err := config.Load()
|
||||||
|
if err != nil {
|
||||||
|
logger.Error("config load failed", "err", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
store, err := storage.Open(cfg.DBPath)
|
||||||
|
if err != nil {
|
||||||
|
logger.Error("storage open failed", "err", err, "path", cfg.DBPath)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
defer store.Close()
|
||||||
|
|
||||||
|
rootCtx, cancelRoot := context.WithCancel(context.Background())
|
||||||
|
defer cancelRoot()
|
||||||
|
|
||||||
|
sender, err := fcm.New(rootCtx, cfg.FirebaseKeyPath)
|
||||||
|
if err != nil {
|
||||||
|
logger.Error("fcm init failed", "err", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
dispatcher := notify.NewDispatcher(store, sender)
|
||||||
|
|
||||||
|
frigateClient, err := frigate.NewClient(
|
||||||
|
cfg.FrigateURL,
|
||||||
|
cfg.FrigateUser,
|
||||||
|
cfg.FrigatePassword,
|
||||||
|
func(payload []byte) {
|
||||||
|
ctx, cancel := context.WithTimeout(rootCtx, 15*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
dispatcher.Send(ctx, payload)
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
logger.Error("frigate client init failed", "err", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
go frigateClient.Run(rootCtx)
|
||||||
|
logger.Info("frigate ws subscriber started", "url", cfg.FrigateURL)
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
handlers.Register(mux, store, cfg)
|
||||||
|
|
||||||
|
srv := &http.Server{
|
||||||
|
Addr: ":" + cfg.Port,
|
||||||
|
Handler: mux,
|
||||||
|
ReadHeaderTimeout: 5 * time.Second,
|
||||||
|
ReadTimeout: 30 * time.Second,
|
||||||
|
WriteTimeout: 30 * time.Second,
|
||||||
|
IdleTimeout: 120 * time.Second,
|
||||||
|
MaxHeaderBytes: 8 * 1024,
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
logger.Info("birdwatch-relay listening", "port", cfg.Port)
|
||||||
|
if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
logger.Error("http server failed", "err", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
stop := make(chan os.Signal, 1)
|
||||||
|
signal.Notify(stop, os.Interrupt, syscall.SIGTERM)
|
||||||
|
<-stop
|
||||||
|
logger.Info("shutdown signal received")
|
||||||
|
|
||||||
|
cancelRoot()
|
||||||
|
|
||||||
|
shutdownCtx, cancelShutdown := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancelShutdown()
|
||||||
|
if err := srv.Shutdown(shutdownCtx); err != nil {
|
||||||
|
logger.Error("shutdown error", "err", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
342
setup.sh
Normal file
342
setup.sh
Normal file
|
|
@ -0,0 +1,342 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
#
|
||||||
|
# birdwatch-relay interactive setup. Run on the NVR (the same Linux machine
|
||||||
|
# that runs Frigate). Asks the questions you need to answer once, generates
|
||||||
|
# secrets, writes config, builds the image, starts the container, and prints
|
||||||
|
# the exact strings to paste into the BirdWatch app.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BOLD='\033[1m'
|
||||||
|
DIM='\033[2m'
|
||||||
|
GREEN='\033[32m'
|
||||||
|
RED='\033[31m'
|
||||||
|
YELLOW='\033[33m'
|
||||||
|
RESET='\033[0m'
|
||||||
|
|
||||||
|
err() { printf "${RED}error:${RESET} %s\n" "$*" >&2; }
|
||||||
|
warn() { printf "${YELLOW}warn:${RESET} %s\n" "$*"; }
|
||||||
|
ok() { printf "${GREEN}ok:${RESET} %s\n" "$*"; }
|
||||||
|
ask() { printf "${BOLD}%s${RESET}" "$*"; }
|
||||||
|
hr() { printf "${DIM}--------------------------------------------------------${RESET}\n"; }
|
||||||
|
|
||||||
|
echo
|
||||||
|
printf "${BOLD}BirdWatch Relay — interactive setup${RESET}\n"
|
||||||
|
hr
|
||||||
|
echo
|
||||||
|
|
||||||
|
cd "$(dirname "$0")"
|
||||||
|
|
||||||
|
# --- Pre-flight ----------------------------------------------------------
|
||||||
|
if ! command -v docker >/dev/null 2>&1; then
|
||||||
|
err "Docker is not installed. Install Docker first:"
|
||||||
|
err " https://docs.docker.com/engine/install/"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if docker compose version >/dev/null 2>&1; then
|
||||||
|
DC="docker compose"
|
||||||
|
elif command -v docker-compose >/dev/null 2>&1; then
|
||||||
|
DC="docker-compose"
|
||||||
|
else
|
||||||
|
err "Docker Compose v2 is required. Install: https://docs.docker.com/compose/install/"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! command -v openssl >/dev/null 2>&1; then
|
||||||
|
err "openssl is required (used to generate the pairing code)."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! command -v curl >/dev/null 2>&1; then
|
||||||
|
err "curl is required (used to verify the relay is healthy)."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! command -v ss >/dev/null 2>&1; then
|
||||||
|
err "ss is required (install iproute2)."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
ok "Docker: $(docker --version)"
|
||||||
|
ok "Compose: $($DC version --short 2>/dev/null || $DC --version)"
|
||||||
|
echo
|
||||||
|
|
||||||
|
# is_port_free returns 0 if no process is listening on $1, non-zero otherwise.
|
||||||
|
is_port_free() {
|
||||||
|
! ss -tlnH 2>/dev/null | awk '{print $4}' | grep -qE ":$1$"
|
||||||
|
}
|
||||||
|
|
||||||
|
# find_free_port walks upward from $1 to find a port nothing is listening on.
|
||||||
|
find_free_port() {
|
||||||
|
local p=$1
|
||||||
|
while [ "$p" -le 65535 ]; do
|
||||||
|
if is_port_free "$p"; then
|
||||||
|
echo "$p"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
p=$((p + 1))
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Step 1: Firebase service-account key --------------------------------
|
||||||
|
printf "${BOLD}Step 1 of 5 — Firebase service-account key${RESET}\n"
|
||||||
|
hr
|
||||||
|
cat <<'EOF'
|
||||||
|
The relay needs a Firebase service-account JSON file. This is a small file you
|
||||||
|
download from Google's Firebase Console — it lets the relay send pushes via
|
||||||
|
Firebase Cloud Messaging.
|
||||||
|
|
||||||
|
If you don't have one yet:
|
||||||
|
1. Open https://console.firebase.google.com
|
||||||
|
2. Click "Add project". Name it (e.g. "birdwatch-home"). Skip Analytics.
|
||||||
|
3. Once created, gear icon → "Project settings" → "Service accounts".
|
||||||
|
4. Click "Generate new private key" → confirm. A .json file downloads.
|
||||||
|
5. Move that file to this NVR.
|
||||||
|
|
||||||
|
Paste the file's full path below.
|
||||||
|
EOF
|
||||||
|
echo
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
ask "Path to Firebase service-account JSON file: "
|
||||||
|
read -r FB_KEY_PATH
|
||||||
|
FB_KEY_PATH="${FB_KEY_PATH/#\~/$HOME}"
|
||||||
|
if [ -z "$FB_KEY_PATH" ]; then
|
||||||
|
err "Path cannot be empty."
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
if [ ! -f "$FB_KEY_PATH" ]; then
|
||||||
|
err "File not found: $FB_KEY_PATH"
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
if ! grep -q '"type"' "$FB_KEY_PATH" 2>/dev/null || \
|
||||||
|
! grep -q '"private_key"' "$FB_KEY_PATH" 2>/dev/null; then
|
||||||
|
err "That doesn't look like a Firebase service-account JSON."
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
break
|
||||||
|
done
|
||||||
|
|
||||||
|
cp "$FB_KEY_PATH" ./firebase-key.json
|
||||||
|
chmod 600 ./firebase-key.json
|
||||||
|
ok "Copied to ./firebase-key.json (chmod 600)."
|
||||||
|
echo
|
||||||
|
|
||||||
|
# --- Step 2: relay port + public URL -------------------------------------
|
||||||
|
printf "${BOLD}Step 2 of 5 — Network${RESET}\n"
|
||||||
|
hr
|
||||||
|
|
||||||
|
PREFERRED_PORT=8080
|
||||||
|
if is_port_free $PREFERRED_PORT; then
|
||||||
|
DEFAULT_PORT=$PREFERRED_PORT
|
||||||
|
ok "Port $PREFERRED_PORT is free on this machine."
|
||||||
|
else
|
||||||
|
SUGGESTIONS=()
|
||||||
|
p=$((PREFERRED_PORT + 1))
|
||||||
|
while [ ${#SUGGESTIONS[@]} -lt 5 ] && [ $p -le 65535 ]; do
|
||||||
|
if is_port_free $p; then
|
||||||
|
SUGGESTIONS+=("$p")
|
||||||
|
fi
|
||||||
|
p=$((p + 1))
|
||||||
|
done
|
||||||
|
if [ ${#SUGGESTIONS[@]} -eq 0 ]; then
|
||||||
|
err "Could not find any free port at or above $PREFERRED_PORT."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
warn "Port $PREFERRED_PORT is already in use on this machine."
|
||||||
|
echo "Available nearby ports: ${SUGGESTIONS[*]}"
|
||||||
|
DEFAULT_PORT=${SUGGESTIONS[0]}
|
||||||
|
fi
|
||||||
|
echo
|
||||||
|
|
||||||
|
cat <<EOF
|
||||||
|
Which port should the relay listen on?
|
||||||
|
- Press ENTER to accept the suggested port: $DEFAULT_PORT
|
||||||
|
- Or type a different number (1-65535) and press ENTER.
|
||||||
|
EOF
|
||||||
|
ask "Port [$DEFAULT_PORT]: "
|
||||||
|
read -r RELAY_PORT
|
||||||
|
RELAY_PORT="${RELAY_PORT:-$DEFAULT_PORT}"
|
||||||
|
if ! [[ "$RELAY_PORT" =~ ^[0-9]+$ ]] || [ "$RELAY_PORT" -lt 1 ] || [ "$RELAY_PORT" -gt 65535 ]; then
|
||||||
|
err "Invalid port: $RELAY_PORT (must be a number between 1 and 65535)."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! is_port_free "$RELAY_PORT"; then
|
||||||
|
err "Port $RELAY_PORT is already in use. Pick another and re-run."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
ok "Will use port $RELAY_PORT."
|
||||||
|
echo
|
||||||
|
|
||||||
|
cat <<EOF
|
||||||
|
What URL will the BirdWatch app on your phone use to reach the relay?
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
https://relay.example.com if you have a TLS reverse proxy in front
|
||||||
|
http://192.168.1.50:$RELAY_PORT if it's LAN-only with no proxy
|
||||||
|
|
||||||
|
Type the FULL URL with scheme (http or https), no trailing slash. If you have
|
||||||
|
a proxy in front (recommended for any remote access), the proxy's URL is what
|
||||||
|
phones use — not this machine's port-mapped URL.
|
||||||
|
|
||||||
|
EOF
|
||||||
|
|
||||||
|
DEFAULT_LANIP="$(hostname -I 2>/dev/null | awk '{print $1}')"
|
||||||
|
DEFAULT_PUB_URL="http://${DEFAULT_LANIP:-192.168.1.x}:$RELAY_PORT"
|
||||||
|
ask "Public URL [$DEFAULT_PUB_URL]: "
|
||||||
|
read -r RELAY_BASE_URL
|
||||||
|
RELAY_BASE_URL="${RELAY_BASE_URL:-$DEFAULT_PUB_URL}"
|
||||||
|
if [[ ! "$RELAY_BASE_URL" =~ ^https?://[^[:space:]]+$ ]]; then
|
||||||
|
err "Public URL must start with http:// or https://"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
RELAY_BASE_URL="${RELAY_BASE_URL%/}"
|
||||||
|
ok "Phones will connect to: $RELAY_BASE_URL"
|
||||||
|
echo
|
||||||
|
|
||||||
|
# --- Step 3: Frigate connection ------------------------------------------
|
||||||
|
printf "${BOLD}Step 3 of 5 — Frigate${RESET}\n"
|
||||||
|
hr
|
||||||
|
cat <<EOF
|
||||||
|
The relay subscribes to Frigate's /ws WebSocket as a long-lived event consumer.
|
||||||
|
It needs your Frigate base URL and (if Frigate has auth enabled) a username
|
||||||
|
and password to log in.
|
||||||
|
|
||||||
|
Recommended: create a dedicated Frigate user just for the relay (e.g.
|
||||||
|
"birdwatch-relay") in Frigate's Auth UI. Limits blast radius if these
|
||||||
|
credentials are exposed.
|
||||||
|
|
||||||
|
EOF
|
||||||
|
|
||||||
|
DEFAULT_FRIGATE_URL="http://localhost:5000"
|
||||||
|
ask "Frigate base URL [$DEFAULT_FRIGATE_URL]: "
|
||||||
|
read -r FRIGATE_URL
|
||||||
|
FRIGATE_URL="${FRIGATE_URL:-$DEFAULT_FRIGATE_URL}"
|
||||||
|
if [[ ! "$FRIGATE_URL" =~ ^https?://[^[:space:]]+$ ]]; then
|
||||||
|
err "Frigate URL must start with http:// or https://"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
FRIGATE_URL="${FRIGATE_URL%/}"
|
||||||
|
|
||||||
|
ask "Frigate username (leave blank if Frigate auth is disabled): "
|
||||||
|
read -r FRIGATE_USER
|
||||||
|
|
||||||
|
FRIGATE_PASSWORD=""
|
||||||
|
if [ -n "$FRIGATE_USER" ]; then
|
||||||
|
ask "Frigate password (input hidden): "
|
||||||
|
read -rs FRIGATE_PASSWORD
|
||||||
|
echo
|
||||||
|
if [ -z "$FRIGATE_PASSWORD" ]; then
|
||||||
|
err "Password cannot be empty when a username is set."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
ok "Frigate URL: $FRIGATE_URL (user: ${FRIGATE_USER:-<none>})"
|
||||||
|
echo
|
||||||
|
|
||||||
|
# --- Step 4: pairing code ------------------------------------------------
|
||||||
|
printf "${BOLD}Step 4 of 5 — Pairing code${RESET}\n"
|
||||||
|
hr
|
||||||
|
PAIRING_CODE=$(openssl rand -hex 3)
|
||||||
|
ok "Pairing code generated."
|
||||||
|
echo
|
||||||
|
|
||||||
|
# --- Step 5: write config + build + start --------------------------------
|
||||||
|
printf "${BOLD}Step 5 of 5 — Write config and start${RESET}\n"
|
||||||
|
hr
|
||||||
|
|
||||||
|
if [ -f .env ]; then
|
||||||
|
warn "Existing .env will be backed up to .env.bak."
|
||||||
|
mv .env .env.bak
|
||||||
|
fi
|
||||||
|
cat > .env <<EOF
|
||||||
|
# Generated by setup.sh on $(date -u +"%Y-%m-%dT%H:%M:%SZ").
|
||||||
|
# Keep this file out of git and off public storage.
|
||||||
|
RELAY_PAIRING_CODE=$PAIRING_CODE
|
||||||
|
FRIGATE_URL=$FRIGATE_URL
|
||||||
|
FRIGATE_USER=$FRIGATE_USER
|
||||||
|
FRIGATE_PASSWORD=$FRIGATE_PASSWORD
|
||||||
|
EOF
|
||||||
|
chmod 600 .env
|
||||||
|
|
||||||
|
if [ -f docker-compose.yml ]; then
|
||||||
|
warn "Existing docker-compose.yml will be backed up to docker-compose.yml.bak."
|
||||||
|
mv docker-compose.yml docker-compose.yml.bak
|
||||||
|
fi
|
||||||
|
|
||||||
|
HOST_UID=$(id -u)
|
||||||
|
HOST_GID=$(id -g)
|
||||||
|
|
||||||
|
cat > docker-compose.yml <<EOF
|
||||||
|
services:
|
||||||
|
relay:
|
||||||
|
build: .
|
||||||
|
container_name: birdwatch-relay
|
||||||
|
restart: unless-stopped
|
||||||
|
user: "$HOST_UID:$HOST_GID"
|
||||||
|
network_mode: host
|
||||||
|
volumes:
|
||||||
|
- ./data:/data
|
||||||
|
- ./firebase-key.json:/secrets/firebase-key.json:ro
|
||||||
|
environment:
|
||||||
|
RELAY_FIREBASE_KEY_PATH: /secrets/firebase-key.json
|
||||||
|
RELAY_PAIRING_CODE: \${RELAY_PAIRING_CODE}
|
||||||
|
RELAY_DB_PATH: /data/relay.db
|
||||||
|
RELAY_PORT: "$RELAY_PORT"
|
||||||
|
FRIGATE_URL: \${FRIGATE_URL}
|
||||||
|
FRIGATE_USER: \${FRIGATE_USER}
|
||||||
|
FRIGATE_PASSWORD: \${FRIGATE_PASSWORD}
|
||||||
|
EOF
|
||||||
|
ok "Wrote .env and docker-compose.yml."
|
||||||
|
|
||||||
|
mkdir -p ./data
|
||||||
|
echo
|
||||||
|
echo "Building image (first build downloads Go and dependencies, ~1 minute)..."
|
||||||
|
$DC up -d --build
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo -n "Waiting for relay to come up"
|
||||||
|
for i in $(seq 1 30); do
|
||||||
|
if curl -sf "http://localhost:$RELAY_PORT/v1/health" >/dev/null 2>&1; then
|
||||||
|
echo " — ok"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
echo -n "."
|
||||||
|
sleep 1
|
||||||
|
if [ "$i" -eq 30 ]; then
|
||||||
|
echo
|
||||||
|
err "Relay did not become healthy in 30 seconds."
|
||||||
|
err "Check logs: $DC logs relay"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# --- Done -----------------------------------------------------------------
|
||||||
|
echo
|
||||||
|
printf "${GREEN}========================================${RESET}\n"
|
||||||
|
printf "${GREEN}Relay is running and connected to Frigate.${RESET}\n"
|
||||||
|
printf "${GREEN}========================================${RESET}\n"
|
||||||
|
echo
|
||||||
|
echo "One thing left to do — pair your phone:"
|
||||||
|
echo
|
||||||
|
printf "${BOLD}In the BirdWatch Android app${RESET}\n"
|
||||||
|
echo " Settings → \"Battery-saver push notifications\" → toggle ON."
|
||||||
|
echo " When asked, paste:"
|
||||||
|
echo " Relay URL: $RELAY_BASE_URL"
|
||||||
|
echo " Pairing code: $PAIRING_CODE"
|
||||||
|
echo
|
||||||
|
echo "(No Frigate config edit is needed. The relay logs into Frigate as $FRIGATE_USER"
|
||||||
|
echo "and subscribes to its event stream directly.)"
|
||||||
|
echo
|
||||||
|
hr
|
||||||
|
echo "Useful commands:"
|
||||||
|
echo " Watch logs: $DC logs -f relay"
|
||||||
|
echo " Restart relay: $DC restart relay"
|
||||||
|
echo " Stop relay: $DC down"
|
||||||
|
echo " Re-run setup: ./setup.sh"
|
||||||
|
echo
|
||||||
|
echo "Files written by this setup (keep them private — never commit them):"
|
||||||
|
echo " ./firebase-key.json — your Firebase service-account key"
|
||||||
|
echo " ./.env — pairing code + Frigate credentials"
|
||||||
|
echo " ./docker-compose.yml — runtime config"
|
||||||
|
echo " ./data/ — SQLite database of registered devices"
|
||||||
|
echo
|
||||||
Loading…
Add table
Add a link
Reference in a new issue