From 282f602eefaf57cdad6d83b03ca45fa76498bcf2 Mon Sep 17 00:00:00 2001 From: Jason Gong Date: Wed, 15 Sep 2021 00:04:25 -0700 Subject: [PATCH] update logos and badges --- README.md | 98 +++++++++++------- .../assets/static/images/logo-text.png | Bin 0 -> 6086 bytes 2 files changed, 61 insertions(+), 37 deletions(-) create mode 100644 apps/fz_http/assets/static/images/logo-text.png diff --git a/README.md b/README.md index b18880428..582749ca1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,37 @@ -![](./apps/fz_http/assets/static/images/logo.svg) +

+ firezone logo +

+

+ + firezone + + + firezone Slack + + + firezone Slack + + + firezone + + + firezone + +

-![Test](https://github.com/firezone/firezone/workflows/Test/badge.svg) -[![Coverage Status](https://coveralls.io/repos/github/firezone/firezone/badge.svg?branch=master)](https://coveralls.io/github/FireZone-LLC/firezone?branch=master) +# Firezone VPN +FireZone is a simple WireGuard™-based VPN server and firewall for Linux designed to be secure, easy to manage, and quick to set up. -# FireZone +![Architecture](./apps/fz_http/assets/static/images/firezone-usage.gif) + +# What is Firezone VPN? + +Firezone can be set up in minutes to: + +- Connect remote teams to a shared private cloud network +- Set up your own WireGuard™ VPN +- Block egress traffic from your devices to specific IPs and CIDR ranges +- Connect remote teams to a secure virtual LAN 1. [Intro](#intro) 2. [Requirements](#requirements) @@ -12,34 +40,8 @@ 5. [Architecture](#architecture) 6. [Contributing](#contributing) -![IMG_0023](https://user-images.githubusercontent.com/167144/132162016-c17635ae-a715-41ca-b6f9-7cbdf202f8d5.png) -## Intro - -FireZone is an open-source WireGuard-based VPN server and firewall for Linux -designed to be secure, easy to manage, and quick to set up. - -Use FireZone to: - -- Connect remote teams to a shared private cloud network -- Set up your own WireGuard VPN -- Block egress traffic from your devices to specific IPs and CIDR ranges -- Connect remote teams to a secure virtual LAN - -## Requirements - -FireZone currently supports the following Linux distros: - -- CentOS: `7`, `8` -- Ubuntu: `18.04`, `20.04` -- Debian: `10`, `11` -- Fedora: `33`, `34` - -If your distro isn't listed here please [open an issue](https://github.com/firezone/firezone/issues/new/choose) and we'll look into adding it. - -FireZone requires a valid SSL certificate and a matching DNS record to run in production. - -## Install +# Deploying and Configuring 1. Download the relevant package for your distribution from the [releases page](https://github.com/firezone/firezone/releases) 2. Install with `sudo rpm -i firezone-.rpm` or `sudo dpkg -i firezone-.deb` depending on your distribution. This will unpack the application and set up necessary directory structure. @@ -49,7 +51,7 @@ FireZone requires a valid SSL certificate and a matching DNS record to run in pr 6. Finally, create an admin user with `sudo firezone-ctl create_admin`. Check the console for the login credentials. 7. Now you should be able to log into the web UI at `https://` -## Usage +# Using Firezone VPN Your FireZone installation can be managed via the `firezone-ctl` command, as shown below. Most subcommands require prefixing with `sudo`. @@ -103,7 +105,22 @@ Service Management Commands: Send the services a USR2. ``` -## Architecture +## Requirements + +FireZone currently supports the following Linux distros: + +- CentOS: `7`, `8` +- Ubuntu: `18.04`, `20.04` +- Debian: `10`, `11` +- Fedora: `33`, `34` + +If your distro isn't listed here please [open an issue](https://github.com/firezone/firezone/issues/new/choose) and we'll look into adding it. + +FireZone requires a valid SSL certificate and a matching DNS record to run in production. + +# Architecture + +![Architecture](./apps/fz_http/assets/static/images/firezone-architecture-diagram-1.png) FireZone is written in the Elixir programming language and composed as an [Umbrella project](https://elixir-lang.org/getting-started/mix-otp/dependencies-and-umbrella-projects.html) @@ -111,14 +128,21 @@ consisting of three independent applications: - [apps/fz_http](apps/fz_http): The Web Application - [apps/fz_wall](apps/fz_wall): Firewall Management Process -- [apps/fz_vpn](apps/fz_vpn): WireGuard Management Process +- [apps/fz_vpn](apps/fz_vpn): WireGuard™ Management Process For now, FireZone assumes these apps are all running on the same host. [Chef Omnibus](https://github.com/chef/omnibus) is used to bundle all FireZone dependencies into a single distributable Linux package. -## Contributing +# Getting Support +For help, feedback or contributions please join our [Slack group](https://admin.typeform.com/form/rpMtkZw4/create?block=a9c11a46-1dcf-4155-b447-0d8ce5700d5f). We're actively working to improve Firezone, and the Slack group is the best way to coordinate our efforts. -See [CONTRIBUTING.md](CONTRIBUTING.md). -WireGuard is a registered trademark of Jason A. Donenfeld. +## Developing and Contributing + +- See [CONTRIBUTING.md](CONTRIBUTING.md). +- Report issues and bugs in [this Github project](). + +## License + +WireGuard™ is a registered trademark of Jason A. Donenfeld. diff --git a/apps/fz_http/assets/static/images/logo-text.png b/apps/fz_http/assets/static/images/logo-text.png new file mode 100644 index 0000000000000000000000000000000000000000..986957892b26f2e2d074bf96b9d904cd7c037497 GIT binary patch literal 6086 zcmbVQhd10$wEt>BBzk9Ai$!!+iPfXCT11K7BX)%ly+(v+t9KG5h#GALt3-+D*$_Q? z528lr`MvZ0f;VT{{mh)Xcjnx4&z;XZeO>kYcbV@30B~PZL&XpP@Dgt4ZX|bZds2N> zs{aOe4Kq&wAfx%O;Q?7WjJF`3r=hwsP&LfDc`Fb)DE1q9ELF53 zbTTveUC7`;A%X@bQP-`22iV-}xW~mQiE})e5QG1+?Z*dV?^7nk?vWy8Pahe?fwt)I zflyHZKPi>;IW;P~a+^Gm0|?!}1*j(0aR=9HH2(Outw5;9EkYo#5T%c4EL8&leRnX} z??a#4yL@)I6R=|KR8U^>bgbw zR-+9V{D?3g3xq-l@R*<{9AF@H2_LVIB8mvGsR#{SA<9|1y$Jz6J^+B}C=;-XV|0Mc z;OzoXPzeCbB!pZPlJ-vQR1&oS@PSuR@t`9*FYL?zN(r};qUx|Bm<&bPgff9Oitl$k6AAF)$L%JLZ35i?*~rDN>>4r|Eq@%WZ~}W0e0^`|zk8C9XsFGy zCj7XkQoh6VJyW>U(adWozR~B=J5;rkII0eXa+ce z)co-;Lj&O>8C+^HbpJw&yVm31S+Y!Spd$~EPq>#sQlWc8 zB0!OiuncaPo0kBsQpZ72c_6Ij!-LXn(}y_jtuo*JdaWK>3NQzwgP#N`P?uOnXFMq!_EuI>DXZtGvUFndXyUvG zaUY-HaU~@R`NQm*?xC8^L|CYUVo#;AH13azf=PaDfn4fMzKcfSo;m$wkXParn5RL( zL~WGYe3Xpvj@qEz$qcNA;SX|8LcY<}2lbQ-czf$zWTK9<;eSHCWHi{0>dv`wTG?sA zzR|_IlQ2GX>MMVa3?BTY{ngYroD;Ch7)A!U#yhfs3j}>Y`QJJ!Jt@vPX>IVE5n+J( zAcVh2D|&9tnm;TZMuD`tZ~)oedrRR2o+44TnNl$cAE_C-dDeY#{`MT7GV)ZeLMXe^ z$k(QGtzyEss>_SWn|M&Mw#J^xXFp`p`&6w_tz@j+KW0y;&#TzCA7_WWIBc`pnXb?AIhq5bzQP%>)&rpIITm%L+fa2I_W;i17O2~a zu#cgG8!BPzsnN1ohQg82AxWbWm3*RLu)_TJ^-F^n$eVPF?6*FJA%3aDY26b=xs
fk~=LlOLwx9b}rbT_dpb|gs zz1lZw?bs|k_M-aO+E4#h@5}Un8fdojm%H|K&X^pB>sS@I<*wDb1|6W<%~CHSMq0Q` zvjRG4wB|}0&$5K{?!Q~`hfv_<&ipP!i}ddQ*UQ`H}BNJCU-0R@fKD4%@%$4yOtDTKjr z>lnS-ZP1|aeNBGFcdmTj^frJdhi=Or2)EiTLw1wHx43aT+2_ai)) zypKnv^+$4qlD9Vc@T}+w0oGplBkddsb~z+m3|y>*8ui#s9WL4Ka8!@ie&*RAd%8X( zfYJ1P*chR+ZdZL9J=5nd(T4SB(L2TIqz;cV$weLzD_1G;?`?d#2L_d%=Qz=ZSg8{$ z!@kg%+KdjfW^)xAS0(?{%Z4O~r+K;4xv zQ4!^Q)!XZ77;h3kAMpJwK|;+7d$X%UPu1#)zJkl_`R$B5E?*`7O^>u7n4*{($v_}b ze4c@DyY6~~c(b+n=gs=S>OK=@tY8ikF;y4^mma=U8tHtTNWlT(WrU(JCY^ds_ibd* zi&{=k7oLl{5vnV<(k^%EJ*(?4pnvHVRaxv}p2!2qG(VPCb85Mr+$y>^*Bs~D%dE;S zhr0B$U(t|MIw5aZ>(6!8{=@r{;=f#Co(qUMKatMFeCxe2__>_^)FZ7x3hN44;tkG~ zFK%-Dd%3qhN3laZQsJwhdon{2VouTqogYD)h&4u(Y|P&wU6?FaRIL4g;4JeEnSKs$ zT%H{@s<9s=kQLX=C4e|Cu-9ywny@CS{K*xvyxzQ7bED?hQ&5%Y50Bc&lJzJ=TQR~s zcE>}Kma;98W2xVF?kxax>LR0M#--y;nw5%tRC$v>Mke3Xjty?C_ruNHi52=g`$IW8 z3^haH!`!>l!k#RFQVR;Ay(8CeR=I{9cFMT~l)WQ+?0G!As=Ju8+wwePH1kMyiEm=* z5-eTFWDA!tKc3N#tv9*i+p&6cmmO?en3=O$8S3a~^AbCE*X-z>8U>OWrXI`lU-I_m zdOm8&_vhcnVCP#dN||ZC;;voz{UZH!k~!VzDSzg=nU7lF83+Q@Pe};f=}4x9+5Tf8fL=dAGf7Lr39C&OCM`-nI*uB z>SUm1?h=b6^FG@poS1aqP4i7@KeajxRzny`9mJS{r_y(RT|3v% zg@@B)9Ihic#W5(elycs-o`}Bow%$FyYqo|F>A#0id@#ExCnOI@F7IjB%;_M)InvtL zBq_Z$sUaI^xQ~5hb-ZDN@!U}HfkfI>^mvf4`h|j#%>IVFX1WSeFvjV+ZK$(+BhX}2 z(`Cc?n|Pjf-FNQ0nMZNb;;7z{_m>fySo+De;La7IroD!9SFI_Rdz@w>Ym*47f%?8k zJL=_l-(2_-gQVDWoM~-Nv*QJSFLQNW7$Ee=mEVnuv3DnNLuvG;j4y4+r+A z?t8e+mS3uiWuQn{dcTXYNlIdkbn?_uqHFEK_}eoN*r{w|VLBgy7)?!{$c~8b<@3?# zSmr;yhSQQ)C9|r3V@y9FR8y#uT*q6T&x;neIX%rM13S5-?lc+*ZE0mU4JoQfcYi9* z<>GH*6gzm<%;~mi8qP_TnJD`w>vLIf&u%11w3#1b6szfwwSrUaub3RvnEI!C>e3jf zDY3<=>1xxu50WpLt=?Oww{jFu)y$~<6fbsnO!p;uVCH!1jt(v$g=%WSL^8(AM!Gns z8+(U);auIxA;-1$gK%NX&lc6^E4cW!he}!K8#(#LVDUV!xe(b?V~s;#+a!g06Wi{y zp+soq7{JpRJ{WSvO{USODRUg6aPs7ZftuZjYBc6E!*>C&7}>&Rc{j@B3|~O|3+O_a zT551p>_YvtbA~><#p`<-lb$sHzfQNzrXu7;YWkqhP!^BOuxM|pFjdl6hgiHX&%gHL zb~L?bZ}ek6sU@T<7n?aVj_Yv52^?h-IbfXnJzLy4TqA4WxtLOFwAFexTl`q2bDPsZlbRt11WS{qf+=cZ zMs_?5$w=VeAM6MTHcs2N*t30!)0G*P8WQL&@PD1DsoKx1V>;#}YR2Xi#9ZFhtFS1u zY;hPxhm%fTdW*-xBFNsG#6P~8x;P?#mlQ3e8KGXN)o;v;IQyU+LgA2hyvnHpC98c8 zF{rgk==FW>Zh|k;Dcr!z<7-s?OKs)fgYZDKaf@?OoGY21Dw|qCG#~g=?gnBv!H2)w zSmq}6kCC}$2_MMfZUaTtp_LQ2s{q$}pU$PZ5o$K zx_To7IzV{02i*7Cj9B4B#z~(hD=fC0eTRyN7WT@9V$x|ORm}GBL=q2IkQS55B1s>Y zC9|^1n-v-T36SGaHutBD4FQFalK|*MA*8)7?)o*A{J-O?lU zOOkJ5y-C~9gtx!P?J1q3C%s-6E}S)T>*4$E&0*aevv+e_GNSYM`@at=7%carebYV= zKTFx(yEzkwT_oSUySAF}TJ0%mTnVCPReUJTq{O%reUpIs?elh5n?479x}9DAuu|YV zRG*X{Ni2xuJAmB{Bb@c>8W56}Xngwy>QI2@s;cvO-i*xIac0j-*psZ-__@O&5F^xf zjmjcR11G*wn(%t!;k_TWY=j{@d~(N5#vm6)02lVwpto2y`^VJ(F6ffmJlc(rXr)d3 z?#M^`ne7aXLOId0dHrvnev_Y8kjqzKKBx2PNLaPIX!B@}KZX*X8XAv|55i}@68f)4 zCB6KlVlrv;%F2n;a9%5TS}zL{lS z3Bj}cnJjW#w3oB-Yhz)FDypElxx)GY+>`KwNtGABWzdni8CV9s*ihf7guVOHB}rLO zS&qIXq>0yJzcw`g^POk}*VUZ<22Q$}@#QR~aRuSR@w>tu=T~7LeOX8U>bGkjRVgXTGEI z4m9$q5Yx?|-1sT87a2z67nPlh7I} z%3}BCyPX6hjg-aebWqFSiA^{@pE*RL8e1f$V(q9t?k?i^%F9M&P<*7Km`qgj%0ID~ z+_ZkKy7kE1Oh1Vz(lK1>xa^D$AAJ?Qx09jp} zY6`wQdo+`utHmkCCA{W}yumb$MrB0kut)R0k_V`xT_3L$sMG~t+{C%6Idl$GtfdHi zp{eQBg*9Z>j=~0(-S#^KAdI0So7HL$ReTvy9K*6q|Ea7XRM{JR>SXDdyH$Kl)`x7D zijKmbGhNso#n&ZbGAggv#Iw$Nv%R!h7F)!`R5z0@DQAv2kxv)?>_1)LCRLKlu3vUP zl-`nIjV=#QG!pG|ZAlZDT%TNBK(pr+og@!_Mnud*hY+Smw(d=LTpE3L0$-ZG?Gc%N z{c0i*`YdnEPyJUMwS7y`PKdNCNSIw{)P-&5J+pL(1535LeKI_(C$)MRer|Fzqv;>m zs{EvUz=^LU=UqzLsZrTsZIkO61L`rtw2XOT7M0OJb(T;CvWXWz9h4fMRq#YOw?V`AVJK6Znt6!#&sD?_t4whS9oq-WD(O!?xpI9 zZ1cNKW9r>YwEy;`@+H}uynlQ=kUeYgG*Q=g=*Eh5HC07UtwL~H^II^&i)~T3|9mL$ zaE#B=NbAX6soE)*M3#YNS(=2UvCK?@%$EBx*1N1vzPxQ=#I)vkwjMK-#m$+1K@~Yc4@q04gUq~MVXr-4Px;t% z(LiKISiRBr&R!V&8m?SglQ1UeZN*R5%8F75j9_t{6T?2uN!vZ&y*@dJE$kFWhhOIT zU00O_j$2cXBcKEIhOANQgAA9Z>Bm@m6_wI2p#H$mFrW8Y1KLP7IZaNTks5dyGcFwJ z43l#uw>*J6F#KC}ZwYdIrSYpNQgx&j+bv&)H`5t@YszgdjGiqcjeS5#$zGMfs%K%% zAKG}Y8shw`E{QHU+$A!aw;<_D8VeOaIXOcetsqWjrpnpwk}LcQ z4j!9)Go$0u`CD!Dwr%-nyC;xPE$emK_y z&&p$A*r)W)$$Y(YJXe_G(Dap)0aM;)TAvD>FwdPYV(cg6?H&jO6ndf_U@)hD_58Z$ zu*(9a#u