mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-03-21 01:41:40 +00:00
28fe571543
* Remove _build folders for umbrella apps
For umbrella apps everything goes into /_build directory so there no need to ignore directories that should never be created
* Change mix aliases to be more aligned with what OS community would expect
1. We want ecto.create and ecto.migrate to be run on each tests, this will simplify setup steps (no need to run migrations manually)
2. ecto.remigrate is not needed because now you can just run ecto.drop and on tests migrations would be executed anyways.
* Rename docker-compose step name in CONTRIBUTING.md
The step was renamed here: dd67baf629 (diff-67a4805fdcc6145d7b3ada2a6099a9b2e91c9d0fd108c22f95d2f01d219793d1R10)
* Remove .devcontainer
This an is opinionated change. Right now devcontainer doesn't work but should be easy to fix (with renaming step name), but at the same time it forces developers that use VS code to have unified development environment (including plugins for the editor itself).
I feel like it's not a good path to go for OS and for small team - everyone should be allowed to use setup they like. Especially for people like me that tend to recompile ls-elixir for Elixir plugin from master branch.
Plus it's yet another thing to maintain while nobody on the team is using it, which means it will be always causing issues.
* Make fz_http mix.exs aliases aligned with umbrella app ones
* Redirect stderr to stdout in a command called from dev.exs
Otherwise I'm getting this on my MacOS (that has a `route` implementation that doesn't show interfaces) when `mix phx.server` is executed:
```
usage: route [-dnqtv] command [[modifiers] args]
```
* Fix race condition due to static device field values
Both public_key and name are unique and we should not use static values for field covered by unique index, otherwise deadlocks and slow tests are expected.
* Remove unwanted transaction block
The changeset code doesn't have any code that accesses the database and individual Ecto.SQL commands are already wrapped in transactions by default, so there is no need to start it manually and hold for longer than expected (while irrelevant Elixir code is running).
* Use netstat to identify egress interface on MacOS
* Rename uninstall.sh to omnibus-uninstall.sh
* Fix uninstall path in omnibus_build.yml
--- title: Overview sidebar_position: 1 --- [Firezone](https://firezone.dev) is an open-source secure remote access platform that can be deployed on your own infrastructure in minutes. Use it to **quickly and easily** secure access to your private network and internal applications from an intuitive web UI.  These docs explain how to deploy, configure, and use Firezone. ## Quick Start 1. [Deploy](deploy): A step-by-step walk-through setting up Firezone. Start here if you are new. 1. [Authenticate](authenticate): Set up authentication using local email/password, OpenID Connect, or SAML 2.0 and optionally enable TOTP-based MFA. 1. [Administer](administer): Day to day administration of the Firezone server. 1. [User Guides](user-guides): Useful guides to help you learn how to use Firezone and troubleshoot common issues. Consult this section after you successfully deploy the Firezone server. ## Common Configuration Guides 1. [Split Tunneling](./user-guides/use-cases/split-tunnel): Only route traffic to certain IP ranges through the VPN. 1. [Setting up a NAT Gateway with a Static IP](./user-guides/use-cases/nat-gateway): Configure Firezone with a static IP address to provide a single egress IP for your team's traffic. 1. [Reverse Tunnels](./user-guides/use-cases/reverse-tunnel): Establish tunnels between multiple peers. ## Get Help If you're looking for help installing, configuring, or using Firezone, check our community support options: 1. [Discussion Forums](https://discourse.firez.one/): Ask questions, report bugs, and suggest features. 1. [Public Slack Group](https://join.slack.com/t/firezone-users/shared_invite/zt-111043zus-j1lP_jP5ohv52FhAayzT6w): Join live discussions, meet other users, and get to know the contributors. 1. [Open a PR](https://github.com/firezone/firezone/issues): Contribute a bugfix or make a contribution to Firezone. If you need help deploying or maintaining Firezone for your team or organization, consider [contacting us about our paid support plan](https://firezone.dev/contact/sales). ## Contribute to Firezone We deeply appreciate any and all contributions to the project and do our best to ensure your contribution is included. To get started, see [CONTRIBUTING.md ](https://github.com/firezone/firezone/blob/master/CONTRIBUTING.md). <!-- Leaving these disabled until they're ready --> <!-- <feedback /> --> <!-- <newsletter /> -->