Commit Graph

310 Commits

Author SHA1 Message Date
Jamil
6ae494904e docs: Update 'user guides' -> 'client apps' (#5940)
- This terminology / naming makes things more clear for most
admins/users.
- Fixes layout of /kb/client-apps to align better

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Not Applicable <ReactorScram@users.noreply.github.com>
2024-07-23 14:04:07 +00:00
Reactor Scram
32014eafbf docs(maintainers): fix (#5894)
Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com>
2024-07-18 15:10:15 +00:00
Jamil
478229e605 docs: update release playbook (#5863)
Update MAINTAINERS.md with most recent release playbook.

```[tasklist]
### Tasks
- [x] Merge `publish_release.md` into `MAINTAINERS.md`
- [ ] Merge PR
```

---------

Co-authored-by: Not Applicable <ReactorScram@users.noreply.github.com>
2024-07-12 21:19:36 +00:00
Jamil
ffe4d5f950 docs: fix references to AWS and Azure example modules (#5829)
These are now published at
https://www.github.com/firezone/terraform-aws-gateway and
https://www.github.com/firezone/terraform-azurerm-gateway to match the
unclear docs for registry module naming...
2024-07-11 16:10:12 +00:00
Jamil
ae87abacff chore: move AWS firezone-gateway module to dedicated repo (#5816)
Why:

Managing the module from Terraform registry is simpler if our published
module is in its own repo.

See https://github.com/firezone/terraform-firezone-aws
2024-07-09 14:05:14 -07:00
Jamil
a14f07cf45 Update README.md
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2024-07-09 06:16:33 -07:00
Jamil
9ac9dedfb9 feat: Azure scalable Gateway module and docs (#5644)
Resolves #2603
2024-07-03 07:16:56 +00:00
Jamil
fc8d89ea73 docs: Add AWS NAT Gateway example (#5543)
- Adds the AWS equivalent of our GCP scalable NAT Gateway.
- Adds a new kb section `/kb/automate` that will contain various
automation / IaaC recipes going forward. It's better to have these
guides in the main docs with all the other info.

~~Will update the GCP example in another PR.~~

Portal helper docs in the gateway deploy page will come in another PR
after this is merged.
2024-06-27 21:05:38 -07:00
FTB_lag
efd0218383 chore: fix contributing docs and fix feature flags in docker compose (#5572) 2024-06-27 11:45:59 -07:00
Jamil
8feb708730 docs: add note for compose v2 (#5110)
fixes #4641

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Reactor Scram <ReactorScram@users.noreply.github.com>
2024-05-23 18:03:01 +00:00
Jamil
bdbc17bb45 docs: Remove too large overview gif (#4878)
This is too large and wasn't being displayed.
2024-05-02 17:58:06 +00:00
Jamil
9606dde1d8 docs: Update README with more 1.x details, add overview screencap (#4877)
https://firezonehq.slack.com/archives/C04HRQTFY0Z/p1714602181648409
2024-05-02 03:11:23 +00:00
Reactor Scram
5faf51f890 chore(docs): formalize the rule for logging sensitive info (#4663)
Closes #4662
2024-04-17 20:19:29 +00:00
Jamil
c8917a58c5 refactor: Discord -> Slack (#4616)
Fixes firezone/bizops#82
2024-04-15 22:05:29 +00:00
Reactor Scram
3a67eacfbe refactor(linux-client): replace client-tunnel with headless-client which is the same thing (#4516)
Unfortunately I had to keep `linux-client` to get the compatibility
tests to pass. #4578 aims to remove that package.

Please add to this list if you think of anything:

```[tasklist]
# Things that may break that CI/CD won't catch
- [ ] Github release artifacts
- [ ] Knowledge base 
- [ ] Docker images
- [ ] Docker containers
- [ ] Existing `linux-client` users
- [ ] Anything that downloads ghcr artifacts
- [ ] Nix (Not sure if it's built in CI. It had a merge conflict)
```

Refs #4515, and #3712, #3782

I think this is what Thomas and I agreed on in Slack / Github

---------

Signed-off-by: Reactor Scram <ReactorScram@users.noreply.github.com>
Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
2024-04-10 22:01:55 +00:00
Jamil
17cf833d8e docs: Mention signup in README and clarify self-hosting (#4528) 2024-04-05 19:33:35 -07:00
Jamil
cd5cde6ce1 chore(repo): Fix whitespace in MAINTAINERS (#4311) 2024-03-25 13:01:50 -07:00
Jamil
d4ba178515 Update MAINTAINERS.md
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2024-03-25 10:35:53 -07:00
Andrew Dryga
09dbd70dc5 chore(infra): Use Regional Instance Group in the GCP NAT example (#4183)
This example will work once our latest gateway is pushed to GitHub
Container Registry, but to test it for now a few overrides can be added
to the `main.tf` to use our Google Artifact Registry and local module
instead:
```diff
module "gateways" {
--  source = "github.com/firezone/firezone/terraform/modules/google-cloud/apps/gateway-region-instance-group"
++  source = "../../../modules/google-cloud/apps/gateway-region-instance-group"
...
++  container_registry = "us-east1-docker.pkg.dev"
++  image_repo         = "firezone-prod/firezone"
++  image              = "gateway"
}
```

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Andrew Dryga <andrew@dryga.com>
Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
2024-03-19 08:44:14 -06:00
Andrew Dryga
114696c0ba chore(infra): Split terraform files into folders and add domain to production app (#4172) 2024-03-16 11:54:06 -06:00
Jamil
81ef6ce7a1 feat(docs): Example Gateway terraform module for GCP (#4011)
Adds a working example of the simplest way to deploy Gateways to GCP
that is also mostly cloud platform agnostic.

I avoided using COS and Docker for this because:

- Systemd is already installed and supports IPv6 already
- Can be more easily adapted to other platforms where Docker may not be
available or trickier to setup (E.g. CentOS 7)
- COS is Google-specific

---------

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Andrew Dryga <andrew@dryga.com>
2024-03-12 10:57:18 -07:00
Jamil
008d891c9e feat(website): March Product Update (#3886)
March newsletter
2024-03-02 10:03:27 -08:00
Jamil
afac720d0d refactor(docs): Update SECURITY.md to mention opening GitHub security advisories (#3787)
fixes #3786
2024-02-29 16:57:10 +00:00
Thomas Eizinger
8d652cb96c chore: add nix scripts (#3771)
Some recent changes to the Rust part of the codebase made it quite
difficult to locally build the project due to tauri's heavy dependencies
on WebKitGTK and other native libraries.

I tried working around this on my local (nix) machine and found it quite
difficult. The cleanest way here is to make use of what Nix calls
"devshells" which give you an environment specifically for hacking on
your project.

Unfortunately, these files need to be tracked in version control and
cannot be ignored (at least I've not found a way to do that). Given that
we already have a lot of clutter in our repository, I put them under
`scripts/nix`.

They are generally useful. I also added a `.envrc` file which
automatically launches the dev-shell. As a result, you have a shell
ready to go with all your dependencies as soon as you `cd` into our
repository (assuming you use `direnv` and it is hooked up with your
shell).

I didn't really want to have any of my local setup leak into the repo
because I think apart from me and @conectado, nobody is using nix, thus
I hope this minimal footprint is an okay compromise.
2024-02-27 23:56:46 +00:00
Thomas Eizinger
67aeb009e9 chore: move markdown files into docs/ directory (#3773)
Apart from the LICENSE, GitHub supports detecting all of these files
also within a `docs/` directory. This includes the README!
2024-02-27 01:12:57 +00:00
Jamil
69335153ce Remove docs.firezone.dev CNAME (#1418)
This corresponds to step (1) of #1417
2023-02-09 15:19:19 -08:00
Jamil
0303ea2811 Short guide on backup / restore (#1411)
Fixes #1270
2023-02-08 12:42:01 -08:00
Jamil
8e73b1b8bb Refactor docs for REST API and consistency (#1404)
Also will include the following:

- [x] Fixes #1281
- [x] Fixes #1218
2023-02-07 08:24:11 -08:00
Jamil
49d4040b60 Add version tag to migrate script (#1400)
* Add new `VERSION` to `docker_migrate.sh` script
* Add missing `SAML_KEYFILE_PATH` and `SAML_CERTFILE_PATH` env vars to
migrate script
* Add missing `PHOENIX_PORT` var
* Bump Elixir to 1.14.3
* Bump Erlang to 25.2.1
* Update docs to document new VERSION var in docker-compose.yml upgrade
mechanism

Fixes #1395
2023-02-01 19:38:55 -08:00
Jamil
dc58d9820f Remove Cockroach note (#1397)
Fixes #1394
2023-02-01 10:18:00 -08:00
Jamil
e4854902cd Revert to old Project API key (#1379)
Also update ping event timer to 1 day, with a 1 minute delay on boot.

Waiting on PostHog to confirm old API key is set.
2023-01-26 12:49:11 -08:00
Jamil
bc6abb55e5 Document auto-create users more clearly in SAML setup guides (#1364)
There's been some confusion lately over the change to disable
auto-create users by default, so this PR aims to document the choice a
little more clearly.

Refs #1362 #1117

Co-authored-by: Andrew Dryga <andrew@dryga.com>
2023-01-23 12:47:18 -06:00
Jamil
394008c008 Chore/update project api key (#1348)
Refs firezone/marketing#109
2023-01-19 19:46:01 -08:00
Jamil
30fe5650ed Update troubleshooting guide for clearing auth config in DB (#1338)
Refs #1313
2023-01-19 17:46:37 -08:00
Jamil
bff52590e1 Migrate DB before using for the first time (#1310) 2023-01-13 17:43:44 -08:00
Jamil
ec321c5619 Update default REST API docs path; Note on stdout api tokens (#1306) 2023-01-13 17:23:21 -06:00
Jamil
330cafbbe5 Boot minimal app for DB changes (#1305)
Adds a minimal supervision tree for making DB changes from the
`FzHttp.Release` module. This allows the `bin/create-or-reset-admin` and
`bin/create-api-token` commands to be with `docker compose exec` or
`docker compose run --rm` indiscriminately.

Starting the FzHttp.Repo directly is more involved it's not compiled
into the release as an OTP app.
2023-01-13 13:45:18 -08:00
Jamil
e2e1dd441b Fix docs link (#1303) 2023-01-13 12:22:52 -08:00
Jamil
b9328c4145 Add note on generating API token (#1294) 2023-01-12 23:12:11 -08:00
Andrew Dryga
6003ea7e26 Generate API docs from tests and Phoenix Controller docs (#1286)
1. The test data is taken from tests, you can override attributes by
adding keyword params to `doc` macro;
2. Additionally, you can add a section title using a `@moduledoc` in a
controller and a controller action title using `@doc` on a controller
function. (It will be added to all instances of its usage).
3. To make parameters nice a helper was added to build it using
`DocHelper`, you can find an example in UserController.

Overall, the code is messy, I'll need to revisit it, but was doing it in
a rush so hope it's good enough for v0.

Results you can see at https://firezone.docs.apiary.io/.

To generate it locally run `DOC=1 mix test
test/fz_http_web/controllers/json`.

Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
2023-01-12 22:40:21 -08:00
Jamil
05ad3f3239 Add HTTP_CLIENT_SSL_OPTS example (#1290)
Fixes #1284 

Coming in 0.7.0
2023-01-12 17:29:59 -08:00
Jamil
ed23d9f346 Use eval for create-or-reset-admin; expose with RESET_ADMIN_ON_BOOT (#1287)
Fixes #1285
2023-01-11 19:55:18 -08:00
Jamil
0cdc3ec1a3 Fix minor deploy docs typos (#1280) 2023-01-09 17:12:35 -08:00
Jamil
19289165e0 Update upgrade.mdx
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2023-01-09 14:06:20 -08:00
Jamil
af74a20de7 Fix docs page crash (#1265)
https://discourse.firez.one/t/issue-with-firezone-documentation/380
2023-01-03 12:21:11 -08:00
Jamil
9a4103318d Expose some http client ssl opts via HTTP_CLIENT_SSL_OPTS (#1221)
Expose the most commonly-used SSL client options to our OIDC and
ConnectivityChecks HTTP clients. Resolves some lingering issues some
users were facing with OIDC where they needed a custom TLS version
enforced or cacert file used to fetch the `discovery_document` and
resulting keys.

SSL misconfiguration can be a security concern, so we intentionally puke
when an unexpected key is passed. This should result in a new GitHub
issue being opened and dialog created to learn more about the use-case.

Fixes #996
2023-01-03 07:38:24 -08:00
Jamil
5b4e9e74e5 Don't assume PostHog is available (#1258)
Fixes #1257
2022-12-31 15:40:23 -06:00
Jamil
1de24ff77e REST API (#1155)
### TODO

- [x] "/v0"
- [x] Double-check migration order; re-timestamp if necessary
- [x] Move `sites` fields to `configurations` so they can be updated
from API
- [x] #1240 -- it introduces possible race conditions for API requests
- [x] #1249 
- [ ] #1008 
- [ ] Final review

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Andrew Dryga <andrew@dryga.com>
2022-12-31 12:58:11 -06:00
Jamil
963aca75cb Update recommendations for local authentication (#1252)
Update the local auth docs to reflect current recommendations.
2022-12-29 17:13:18 -06:00
Jason G
7ad73b7b25 Remove broken link in docs (#1253) 2022-12-29 13:44:07 -06:00