Commit Graph

70 Commits

Author SHA1 Message Date
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
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
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
Jamil
de3919fb69 Add SupportOptions component and utm_source for links (#1219)
This PR also moves to `yarn` for docs package management for improved
speed, security, and developer experience. Docusaurus prefers yarn.

Refs firezone/marketing#126
2022-12-24 16:16:55 -06:00
Jamil
25e7de4f24 Enrichment (#1220)
* Debug TID

* Use new TID from wrapped install script

* Add as script param
2022-12-20 22:20:30 -06:00
Jamil
2b216a1d58 Update Docker IPv6 CIDR to use 2001:db8:1::/64 (#1213)
See https://github.com/firezone/firezone/issues/1202#issuecomment-1357294785
2022-12-19 07:37:36 -06:00
Jason G
5f6685c5aa General Docs Improvements (#1194)
* docs: add logs and update troubleshooting

Updates the troubleshooting doc for Docker based deployments and adds a general logs doc with more info on what Firezone logs.

Also added a mention of Audit logs in beta to source more convos.

* docs: further Docker clarifications

Clarifying some troubleshooting guides that refer to firezone-ctl.

Not everyone arrives at the env-vars or config file through the deploy/configure guide. Some load these pages directly via search. Adding a more prominent note that it's for Omnibus based deploy.

* docs: add troubleshooting docs on locked out state

Adding a section on reseting admin passwords for both docker and omnibus deployments. I realize we removed the omnibus firezone-ctl reference. I won't add it back since I have no idea where to put it.

* docs: update split tunnel doc

Was originally going to write more about other ways you can achieve split tunneling with wireguard, but will leave that for now

* fix whitespace

* update split tunnel doc

* docs: add DNS considerations to split tunnel doc

https://github.com/firezone/product/issues/527

* update split tunnel doc

* further clarify split tunnel doc

* add note about on-demand feature

* Docs - Improve titles and descriptions (#1187)

* docs: update titles, descriptions

Changes:
- set more descriptive titles (better for readers and SEO)
- add meta descriptions
- convert titles to sentence case for consistency

* docs: small fixes

* fix trailing whitespaces

* fix spelling

* Apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

* add descriptions to client instructions

Signed-off-by: Jason G <jason@firez.one>
Co-authored-by: Jamil <jamilbk@users.noreply.github.com>

* chore: update logs doc

* chore: apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

* chore: line length and log description

* chore: rename debug logs

* chore: apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

* Docs - Add draft whitelist sso doc (#1185)

* doc: adding whitelist sso doc

redo of https://github.com/firezone/firezone/pull/995

* docs: add seo titles

* docs: improve titles

* grammar fixes

* fix trailing whitespace

apparently my vscode plugin does not find trailing whitespace in front matter

* put doc in draftmode

* add note on wireguard client apps

* Revert "add note on wireguard client apps"

This reverts commit 9013ce1c3b1bcb8b825f0fcbb1c5fe7e050cae82.

* Apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

Signed-off-by: Jason G <jason@firez.one>
Co-authored-by: Jamil <jamilbk@users.noreply.github.com>

* chore: apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

* chore: Update docs/docs/user-guides/client-instructions.mdx

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Jason G <jason@firez.one>

* chore: update title capitalization and other small fixes

* Apply suggestions from code review

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>

Signed-off-by: Jason G <jason@firez.one>
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
2022-12-18 21:07:11 -06:00
Jamil
c18d52cec8 Fix IPv6 routing for Docker-based deployments (#1204)
* Add instructions for enabling IPv6 within Docker

IPv6 routing is disabled by default on Docker. To have IPv6 work in Firezone
the same way IPv4 currently does (and IPv6 on Omnibus), four things are
generally required:

1. First, ensure your Docker host has IPv6 correctly set up with a quick
   ping test:
  ```
  > ping6 -c 4 google.com

  PING google.com(sfo03s32-in-x0e.1e100.net (2607:f8b0:4005:814::200e)) 56 data bytes
  64 bytes from sfo03s32-in-x0e.1e100.net (2607:f8b0:4005:814::200e): icmp_seq=1 ttl=51 time=1.96 ms
  64 bytes from sfo03s32-in-x0e.1e100.net (2607:f8b0:4005:814::200e): icmp_seq=2 ttl=51 time=1.94 ms
  64 bytes from sfo03s32-in-x0e.1e100.net (2607:f8b0:4005:814::200e): icmp_seq=3 ttl=51 time=1.92 ms
  64 bytes from sfo03s32-in-x0e.1e100.net (2607:f8b0:4005:814::200e): icmp_seq=4 ttl=51 time=1.90 ms
  ```
2. Add an IPv6 address, subnet, and `enable_ipv6: true` to the Docker
   compose. **Note**: Various Googling around the interwebs will uncover
   the myth that `enable_ipv6` is not supported on Docker Compose file
   versions 3+ -- this seems to be incorrect. Leaving out `enable_ipv6: true`
   prevented Docker from automatically assigning IPv6 addresses for
   containers attaching to that network.
3. Add the following to `/etc/docker/daemon.json`:
  ```json
  {
    "ipv6": true,
    "ip6tables": true,
    "experimental": true,
    "fixed-cidr-v6": "fd00:dead:beef::/80"
  }
  ```
4. The above causes Docker to automatically add `ip6tables` rules to
  set up IPv6 NAT/Masquerade for containers. However, this breaks DHCPv6
  Router Advertisements, so you'll need to re-enable them for your
  default interface with:
  ```
  egress=`ip route show default 0.0.0.0/0 | grep -oP '(?<=dev ).*' | cut -f1 -d' ' | tr -d '\n'`
  sudo echo "net.ipv6.conf.${egress}.accept_ra=2" >> /etc/sysctl.conf
  ```

* Fix bash cmd

* Apply suggestions from code review

Self-review

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-12-18 16:49:36 -06:00
Jamil
a994f3f350 Update esaml to properly parse signed assertions (#1113)
* Update esaml to properly parse signed assertions

* Add Jumpcloud SAML doc

* Add required fields to config

* Add required fields to config

* Fix typo

* Formatting

* Minor fixes

* More clarifying

* yet more typo fixes

* Fix test
2022-11-15 21:34:31 -08:00
Jamil
245f3d2d93 Backlink config reference to configure guide (#1107)
* add note on configuring

* typo

* Backlink to configure guide

* add note to docker
2022-11-15 08:52:03 -08:00
Jamil
911a82ce05 Update README.mdx
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-09 07:29:59 -08:00
Jamil
7bbf993eed Update README.mdx
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-09 07:29:38 -08:00
Jamil
9b1982c408 Fix omnibus install link
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-09 00:18:11 -08:00
Gabi
029891c69e Build/fix no prefix (#1089)
* fix: use caddy in host network_mode and make sure urls have a scheme

* fix: remove unnecesary exposed ports

* fix: remove support for hostnames begining with // since caddy doesn't support it

* Fix schemeless external URLs; error on invalid ones (#1090)

* Fix schemeless external URLs; error on invalid ones

* use different dockerfile for linux vs non-linux

* Use conditional EXTERNAL_URL defaults

* suppress empty warning

* postgres volume location

* Use inline Caddyfile

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-03 19:36:37 -07:00
Jamil
368ff3e55c Add restart note (#1085)
* Update README.mdx

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>

* Update docs/docs/deploy/docker/README.mdx

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-03 11:58:19 -07:00
Andrew
85359bdb11 Add a building from source doc for Firezone (#1078)
* Add a building from source doc for Firezone

* Apply suggestions from code review

Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Signed-off-by: Andrew Rousset <andrew@firezone.dev>

Signed-off-by: Andrew Rousset <andrew@firezone.dev>
Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
2022-11-01 12:48:57 -07:00
Jamil
45ef146532 Fix links related to ignoreSlash (#1075) 2022-10-28 13:59:06 -07:00
Jamil
5ad4c8ccd5 Minor docs fixes (#1071)
* sudo for migrate

* Use sudo for cat

* docker-compose version 2 or higher
2022-10-27 16:28:26 -07:00
Jason G
59776d6d93 docs: rename business to enterprise (#1060)
* docs: rename business to enterprise

* fix link

Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
2022-10-26 14:44:24 -07:00
gongjason
ca7d6f40b1 Revert "docs: rename business to enterprise"
This reverts commit 5576b5b6ae.
2022-10-25 10:42:51 -07:00
gongjason
5576b5b6ae docs: rename business to enterprise 2022-10-25 10:40:18 -07:00
Jamil
dd9841cd94 Polish install, migration script, docs (#1050)
* Checkpoint

* Checkpoint

* checkpoint

* fix typo

* Update migrate with changes

* UID and GID

* fix perms

* Remove custom user

* Fix migrate script typos

* fix grep

* remove cleverness

* migrate final fixes
2022-10-20 13:43:31 -07:00
Jamil
bf6874df56 Update README.mdx
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-10-20 09:46:40 -07:00
Jamil
b20b1336c4 docker_install -> install (#1040)
* Use install.sh

* rename docker_install -> install
2022-10-18 12:03:52 -07:00
Jamil
7fc2708346 fix manual steps (#1037) 2022-10-17 15:32:11 -07:00
thermionic
f3f1f4771b Update reverse-proxy.mdx (#1035)
1926.0.0/16 to 192.168.0.0/16

Signed-off-by: thermionic <thermionic@lovius.net>

Signed-off-by: thermionic <thermionic@lovius.net>
2022-10-17 15:10:57 -07:00
Jamil
c2bc2469eb Update README.mdx
Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
2022-10-16 15:26:59 -07:00
Jamil
d963929c07 0.6.0 (#1004)
* 0.6.0

* Make OIDC and SAML user provisioning configurable per-provider (#1015)

* Got ugly migration to work

* Move auto_create_users to per-provider config

* Update deps to bust cache

* Update Process sleep

* Update docs with Auto create users

* working migration script (#1013)

* Add telem for Docker and SAML (#1020)

* Add telem for Docker and SAML

* Omit unneeded format
2022-10-13 15:22:53 -07:00
Jamil
21d2203b3e Fix docs links (#990)
* Fix docusaurus ver

* Update docusaurus

* Why broken

* fix css minimizer :-(

* Fix links
2022-09-29 13:45:17 -05:00
Jamil
ae111ad437 Add websocket connection troubleshooting section (#977)
* Remove markdown exceptions for table and code blocks

* Fix Zitadel docs errors

* Add trailingSlash: false to prevent 404 bug
2022-09-23 15:35:01 -07:00
Jamil
41ff3c3b3f Cache node deps; fix minor docs typos (#923)
* Minor typo fixes

* cache node deps

* Remove unneeded script

* Remove unneeded script

* Remove redundant lint-docs step...

* Cache nodejs for static anal

* npm ci before use

* limit markdownlint to docs for now

* Move markdownlint config to root
2022-08-18 21:01:04 -07:00
Jamil
4d73df77bc Fix wording (#895) 2022-08-08 10:47:13 -07:00
Andrew
5487a36e79 Restore the manual install steps to install server docs. (#873)
* Improve install docs some & restore the manual install steps

* Fix docs lint

* Remove space in RedHat

* fix typo
2022-07-28 14:39:00 -07:00
Jamil
dafbc54b09 Fix minor mistakes (#859) 2022-07-27 07:34:34 -07:00
Jamil
b5d5028b9f prefix with sudo (#853)
* prefix with sudo

* Update docs/docs/deploy/README.md

Co-authored-by: Andrew <andrew@firezone.dev>

Co-authored-by: Andrew <andrew@firezone.dev>
2022-07-26 11:53:40 -07:00
Gabi
23db81fae5 Build/729/different reverse proxy (#795)
* Removes disabling SSL and adds remote_ip lib

* Fix to use remote_ip when not proxy

* Add trusted_proxy to config

* Add proxy_forwarded prameter to config and improve logging

* Fix trusted_proxy list parsing

* Fix ip formatting

* Expect JSON array for trusted_proxy

* fix proxied-related plug loading runtime

* fix typo

* checkpoint

* add traefik draft

* add logging

* woops

* adding logging for debug

* rollback debugging logs

* docs refinement

* Fix markdown lints

* remove disabling proxy_forwarded option for prod

* rename, improve docs and add clients config

* change dev_secure to secure_cookies

* Set proxy_forwarded as true by default

* remove proxy_forwarded in favor of nil trusted_proxies

* renaming and doc improvement

* build fix

* jamilbk changes

Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>
2022-07-25 11:47:58 -07:00
Jason G
0239e12ede Minor fixes and polish to docs (#831)
* remove duplicate files for nftables

* github logo in navbar

* add company links to footer

* use auto-generated indexes

* make use of swizzling

* SEO

* lint error
2022-07-25 11:47:58 -07:00
Andrew
2f11771d59 Update install script and docs for Cloudsmith package repo (#809)
* Update install script to setup and install firezone from cloudsmith repo

* silence source repo file not found when removing

* Update docs with cloudsmith repo instructions, add feedback message to uninstall

* Fix supported platforms link

* add upgrade note to post install pkg script & only grep config file for check if it exists

* Clean up install server doc links

* use apt-get instead of apt, add RHEL 7,8,9 & OLS 7,8,9

* Use more cross platform compatible terminal text styles
2022-07-25 11:47:58 -07:00
Jamil Bou Kheir
ef5630f94f Fix linter error 2022-07-25 11:47:58 -07:00
Jamil
4687220684 Acme support (#779)
* Bump nodejs to 16 lts (#772)

* Move docs to Docusaurus (#726)

* wait 10

Co-authored-by: Andrew <andrew@firezone.dev>
Co-authored-by: Chetan Verma <chetan61verma@gmail.com>
2022-07-25 11:47:58 -07:00
Chetan Verma
afefde7110 Move docs to Docusaurus (#726) 2022-07-25 11:47:58 -07:00
Jamil
834a1f5191 Update index.md (#749) 2022-06-22 23:13:55 -07:00
Jamil
f84df97c86 Update install script to support Ubuntu 22.04 (#733) 2022-06-18 10:52:46 -04:00
lilibobear
21e9c1cebb Removed sentence and updated Heading (#709) 2022-06-14 13:09:12 -07:00
Jason G
8576d874a3 Improve deployment docs (#673)
* simplify deployment instructions

* fix lint error

* add troubleshooting section

* additional server instrucrtions

* clarify supported distros in intro

* punctuation

* upgrade to 0.3.17

* clarifications from review

@jamilbk changed based on your comments. There was a section about upgrading that was supposed to be in another branch (OIDC). I removed that.

@lilibobear added a screenshot

* add note for ssh interruptions during install

* link to github issue for ssh interrupt

* review note fixes

* testing signed commit

* update gpg email
2022-06-08 04:41:05 -07:00
Jamil
4fa5bedf1b 500/fix redirect local auth (#509)
* Allow config of ext url; show this after create-admin

* Use opts for ueberauth

* weird nil error

* get_env vs fetch_env

* Use integer

* Try new external_url thingo

* Fix callback_url

* Fix path suffix

* Fix markdownlint hiccup

* fix create admin

* Differentiate phoenix_port

* cron note; installscript fix; minor fqdn fixes

* Send full node obj to app_env

* Add db pass to config file
2022-04-05 14:43:00 -07:00
Jamil
150fd5fc03 Minor docs fixes (#505)
* Minor docs fixes

* MD012 fix

Co-authored-by: Jason Gong <jason@firez.one>
2022-03-15 20:32:22 -05:00
Jason G
b54684a154 Authentication documentation (Google, Okta) (#483)
* add links to common configurations

* add Google auth doc

restructure auth section and add start to google sso draft

* Add Okta doc first draft

* update authentication index

* fix wording

* grammar

* suggested changes

- resolved comments
- images wider for visibility
- newline

* complete Google OAuth doc

* lint error + grammar

* complete Okta doc

* ordering + wording

* re-auth instructions

* fixes

* consistent references

* add reference to sso in add users doc

* fix small markdown error
2022-03-04 17:15:43 -08:00