mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
Fix install script location (#1789)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"trailingComma": "es5",
|
||||
"tabWidth": 2,
|
||||
"semi": false,
|
||||
"semi": true,
|
||||
"singleQuote": false
|
||||
}
|
||||
|
||||
38
README.md
38
README.md
@@ -9,8 +9,8 @@
|
||||
<img src="https://img.shields.io/static/v1?logo=discourse&logoColor=959DA5&label=support%20forum&labelColor=333a41&message=join&color=611f69" alt="firezone Discourse" />
|
||||
</a>
|
||||
<img src="https://img.shields.io/static/v1?logo=github&logoColor=959DA5&label=Test&labelColor=333a41&message=passing&color=3AC358" alt="firezone" />
|
||||
<a href="https://coveralls.io/github/firezone/firezone?branch=master">
|
||||
<img src="https://coveralls.io/repos/github/firezone/firezone/badge.svg?branch=master" alt="Coverage Status" />
|
||||
<a href="https://coveralls.io/github/firezone/firezone?branch=legacy">
|
||||
<img src="https://coveralls.io/repos/github/firezone/firezone/badge.svg?branch=legacy" alt="Coverage Status" />
|
||||
</a>
|
||||
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/firezone/firezone"/>
|
||||
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/firezone/firezone"/>
|
||||
@@ -24,9 +24,9 @@
|
||||
|
||||
## [Firezone](https://www.firezone.dev/?utm_source=readme) is a self-hosted VPN server and Linux firewall
|
||||
|
||||
* Manage remote access through an intuitive web interface and CLI utility.
|
||||
* [Deploy on your own infrastructure](https://docs.firezone.dev/deploy?utm_source=readme) to keep control of your network traffic.
|
||||
* Built on [WireGuard®](https://www.wireguard.com/) to be stable, performant, and lightweight.
|
||||
- Manage remote access through an intuitive web interface and CLI utility.
|
||||
- [Deploy on your own infrastructure](https://docs.firezone.dev/deploy?utm_source=readme) to keep control of your network traffic.
|
||||
- Built on [WireGuard®](https://www.wireguard.com/) to be stable, performant, and lightweight.
|
||||
|
||||

|
||||
|
||||
@@ -43,21 +43,21 @@ Using Firezone in production at your organization? Contact us to learn about our
|
||||
|
||||

|
||||
|
||||
* **Fast:** Uses WireGuard® to be [3-4 times](https://wireguard.com/performance/) faster than OpenVPN.
|
||||
* **SSO Integration:** Authenticate using any identity provider with an OpenID Connect (OIDC) connector.
|
||||
* **Containerized:** All dependencies are bundled via Docker.
|
||||
* **Simple:** Takes minutes to set up. Manage via a simple CLI.
|
||||
* **Secure:** Runs unprivileged. HTTPS enforced. Encrypted cookies.
|
||||
* **Firewall included:** Uses Linux [nftables](https://netfilter.org) to block unwanted egress traffic.
|
||||
- **Fast:** Uses WireGuard® to be [3-4 times](https://wireguard.com/performance/) faster than OpenVPN.
|
||||
- **SSO Integration:** Authenticate using any identity provider with an OpenID Connect (OIDC) connector.
|
||||
- **Containerized:** All dependencies are bundled via Docker.
|
||||
- **Simple:** Takes minutes to set up. Manage via a simple CLI.
|
||||
- **Secure:** Runs unprivileged. HTTPS enforced. Encrypted cookies.
|
||||
- **Firewall included:** Uses Linux [nftables](https://netfilter.org) to block unwanted egress traffic.
|
||||
|
||||
### Anti-features
|
||||
|
||||
Firezone is **not:**
|
||||
|
||||
* An inbound firewall
|
||||
* A tool for creating mesh networks
|
||||
* A full-featured router
|
||||
* An IPSec or OpenVPN server
|
||||
- An inbound firewall
|
||||
- A tool for creating mesh networks
|
||||
- A full-featured router
|
||||
- An IPSec or OpenVPN server
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -70,11 +70,11 @@ If you're looking for help installing, configuring, or using Firezone, check our
|
||||
community support options:
|
||||
|
||||
1. [Discussion Forums](https://discourse.firez.one/?utm_source=readme): Ask questions, report
|
||||
bugs, and suggest features.
|
||||
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.
|
||||
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.
|
||||
or make a contribution to Firezone.
|
||||
|
||||
If you need help deploying or maintaining Firezone for your business, consider
|
||||
[contacting us about our paid support plan](https://www.firezone.dev/sales?utm_source=readme).
|
||||
@@ -87,7 +87,7 @@ If you need help deploying or maintaining Firezone for your business, consider
|
||||
|
||||
[](https://cloudsmith.com)
|
||||
|
||||
Package repository hosting is graciously provided by [Cloudsmith](https://cloudsmith.com).
|
||||
Package repository hosting is graciously provided by [Cloudsmith](https://cloudsmith.com).
|
||||
Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that
|
||||
enables your organization to create, store and share packages in any format, to any place, with total
|
||||
confidence.
|
||||
|
||||
@@ -10,9 +10,9 @@ identity providers like Okta and OneLogin.
|
||||
## Docker Support
|
||||
|
||||
Docker is now the preferred method for deploying Firezone. Our
|
||||
[automatic install script](https://raw.githubusercontent.com/firezone/firezone/master/scripts/docker_install.sh)
|
||||
[automatic install script](https://raw.githubusercontent.com/firezone/firezone/legacy/scripts/docker_install.sh)
|
||||
now uses Docker by default, and we even have a new
|
||||
[Docker migration script ](https://raw.githubusercontent.com/firezone/firezone/master/scripts/docker_migrate.sh)
|
||||
[Docker migration script ](https://raw.githubusercontent.com/firezone/firezone/legacy/scripts/docker_migrate.sh)
|
||||
that will non-destructively migrate your Omnibus-based Firezone installation to
|
||||
a Docker-based one with minimal downtime.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ custom reverse proxy) will likely need extra troubleshooting and manual steps
|
||||
taken to perform a successful migration.
|
||||
|
||||
Take a look at the
|
||||
[migration script source ](https://github.com/firezone/firezone/blob/master/scripts/docker_migrate.sh)
|
||||
[migration script source ](https://github.com/firezone/firezone/blob/legacy/scripts/docker_migrate.sh)
|
||||
to get a detailed idea of the steps involved.
|
||||
|
||||
Estimated time to complete: **2 hours**.
|
||||
@@ -48,7 +48,7 @@ Estimated time to complete: **2 hours**.
|
||||
1. Download and run the migration script:
|
||||
|
||||
```bash
|
||||
bash <(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/docker_migrate.sh)
|
||||
bash <(curl -fsSL https://github.com/firezone/firezone/raw/legacy/scripts/docker_migrate.sh)
|
||||
```
|
||||
|
||||
This will ask you a few questions, then attempt to migrate your installation to
|
||||
|
||||
@@ -27,10 +27,10 @@ rm -rf $installDir
|
||||
<TabsItem title="Omnibus">
|
||||
|
||||
To completely remove Omnibus-based deployments of Firezone run the
|
||||
[uninstall.sh script](https://github.com/firezone/firezone/blob/master/scripts/omnibus-uninstall.sh):
|
||||
[uninstall.sh script](https://github.com/firezone/firezone/blob/legacy/scripts/omnibus-uninstall.sh):
|
||||
|
||||
```bash
|
||||
sudo /bin/bash -c "$(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/omnibus-uninstall.sh)"
|
||||
sudo /bin/bash -c "$(curl -fsSL https://github.com/firezone/firezone/raw/legacy/scripts/omnibus-uninstall.sh)"
|
||||
```
|
||||
|
||||
</TabsItem>
|
||||
|
||||
@@ -40,7 +40,7 @@ Then use them with your Firezone installation:
|
||||
|
||||
Set the `SAML_KEYFILE_PATH` and `SAML_CERTFILE_PATH` environment variables to
|
||||
the path containing your `saml.key` and `saml.crt` above. If using our
|
||||
[example docker compose file](https://github.com/firezone/firezone/blob/master/docker-compose.prod.yml),
|
||||
[example docker compose file](https://github.com/firezone/firezone/blob/legacy/docker-compose.prod.yml),
|
||||
which includes a volume for mapping configuration, save these files to
|
||||
`$HOME/.firezone/firezone` on the Docker host and set the
|
||||
`SAML_KEYFILE_PATH=/var/firezone/saml.key` and
|
||||
|
||||
@@ -29,7 +29,7 @@ and info about configuring a reverse proxy is
|
||||
|
||||
<Alert color="info">
|
||||
Check the `.tool-versions` file
|
||||
[here](https://github.com/firezone/firezone/blob/master/.tool-versions) for
|
||||
[here](https://github.com/firezone/firezone/blob/legacy/.tool-versions) for
|
||||
the versions we use for Erlang, Elixir, and Node. If your system supports it,
|
||||
you can install these using
|
||||
[asdf-vm](https://asdf-vm.com/guide/getting-started.html) using a similar
|
||||
|
||||
@@ -48,7 +48,7 @@ The easiest way to deploy Firezone with Docker is the automatic install script:
|
||||
|
||||
<CodeBlock
|
||||
language="bash"
|
||||
codeString="bash <(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/install.sh)"
|
||||
codeString="bash <(curl -fsSL https://github.com/firezone/firezone/raw/legacy/scripts/install.sh)"
|
||||
/>
|
||||
|
||||
This will ask you a few questions regarding initial configuration, then proceed
|
||||
@@ -66,13 +66,13 @@ installation process, follow the steps below to install manually.
|
||||
Linux**:
|
||||
|
||||
```
|
||||
curl -fsSL https://raw.githubusercontent.com/firezone/firezone/master/docker-compose.prod.yml -o docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/firezone/firezone/legacy/docker-compose.prod.yml -o docker-compose.yml
|
||||
```
|
||||
|
||||
**For macOS, Windows (non-production only)**:
|
||||
|
||||
```
|
||||
curl -fsSL https://raw.githubusercontent.com/firezone/firezone/master/docker-compose.desktop.yml -o docker-compose.yml
|
||||
curl -fsSL https://raw.githubusercontent.com/firezone/firezone/legacy/docker-compose.desktop.yml -o docker-compose.yml
|
||||
```
|
||||
|
||||
1. Generate required secrets:
|
||||
|
||||
@@ -52,14 +52,15 @@ The easiest way to get started using Firezone is via the automatic installation
|
||||
script below.
|
||||
|
||||
```bash
|
||||
sudo -E bash -c "$(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/omnibus_install.sh)"
|
||||
sudo -E bash -c "$(curl -fsSL https://github.com/firezone/firezone/raw/legacy/scripts/omnibus_install.sh)"
|
||||
```
|
||||
|
||||
This will ask you a few questions regarding your install, install the latest
|
||||
release for your platform, create an administrator user, then print to the
|
||||
console instructions for logging in to the web UI.
|
||||
|
||||
<Image className="mx-auto"
|
||||
<Image
|
||||
className="mx-auto"
|
||||
alt="install complete"
|
||||
src="/images/install-complete.png"
|
||||
width={960}
|
||||
|
||||
@@ -55,4 +55,4 @@ deployments). Local authentication can also be disabled on the
|
||||
## Reporting security issues
|
||||
|
||||
To report any security-related bugs, see
|
||||
[our security bug reporting policy ](https://github.com/firezone/firezone/blob/master/SECURITY.md).
|
||||
[our security bug reporting policy ](https://github.com/firezone/firezone/blob/main/SECURITY.md).
|
||||
|
||||
@@ -12,7 +12,8 @@ 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.
|
||||
|
||||
<Image className="mx-auto"
|
||||
<Image
|
||||
className="mx-auto"
|
||||
width={960}
|
||||
height={540}
|
||||
alt="firezone architecture"
|
||||
@@ -50,4 +51,4 @@ These docs explain how to deploy, configure, and use 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).
|
||||
[CONTRIBUTING.md](https://github.com/firezone/firezone/blob/main/CONTRIBUTING.md).
|
||||
|
||||
@@ -608,7 +608,7 @@ export default function Page() {
|
||||
<div className="mt-8">
|
||||
<CodeBlock
|
||||
language="bash"
|
||||
codeString="bash <(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/install.sh)"
|
||||
codeString="bash <(curl -fsSL https://github.com/firezone/firezone/raw/legacy/scripts/install.sh)"
|
||||
/>
|
||||
</div>
|
||||
<p className="mt-8 border-y font-semibold text-xl w-12 max-w-screen-md text-center text-neutral-200 dark:text-neutral-100">
|
||||
|
||||
Reference in New Issue
Block a user