From 322893303adf377ecca1cc5e45ab8b61a32357eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20W=C3=B3jcik?= Date: Mon, 14 Aug 2023 08:34:06 +0200 Subject: [PATCH 1/2] add license --- LICENSE | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8ddd140 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2023 teonite ventures sp. z o.o. (teonite) + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. From f12dca1df1891490edf4ec46bf3df7e27b115c0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20W=C3=B3jcik?= Date: Mon, 14 Aug 2023 08:39:11 +0200 Subject: [PATCH 2/2] update readme --- README.md | 34 +++++++++++++++++++++++++++++++--- docs/header.png | Bin 0 -> 4445 bytes 2 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 docs/header.png diff --git a/README.md b/README.md index db0130d..20c428d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# DefGuard Proxy +

+ defguard +

+ +This service is meant to serve as a proxy for a subset of functionalities of [defguard](https://github.com/DefGuard/defguard) core which require public access. +It provides a public REST API and communicates with core over [gRPC](https://github.com/DefGuard/proto). + +To learn more about the system see our [documentation](https://defguard.gitbook.io). + +## Quick start + +If you already have your defguard instance running you can set up a proxy by following our [deployment guide](https://defguard.gitbook.io/defguard/features/setting-up-your-instance/docker-compose). + +## Documentation + +See the [documentation](https://defguard.gitbook.io) for more information. + +## Community and Support + +Find us on Matrix: [#defguard:teonite.com](https://matrix.to/#/#defguard:teonite.com) + +## Contribution + +Please review the [Contributing guide](https://defguard.gitbook.io/defguard/for-developers/contributing) for information on how to get started contributing to the project. You might also find our [environment setup guide](https://defguard.gitbook.io/defguard/for-developers/dev-env-setup) handy. -This service is meant to serve as a proxy for a subset of functionalities of DefGuard core which require public access. -It provides a public REST API and communicates with core over gRPC. ## Development @@ -19,3 +40,10 @@ To run API server: ```bash cargo run ``` + +To run webapp dev server: +```bash +cd web/ +pnpm install +pnpm run dev +``` diff --git a/docs/header.png b/docs/header.png new file mode 100644 index 0000000000000000000000000000000000000000..6e4d1b9d23f3b93d17bc2bd16d07bdc6a65e5efa GIT binary patch literal 4445 zcmbVQ2~?9;_K&3k3Ir4tt)CEsEvP^O0TQAiqM?B*sO%I2h9qEwkdJIEqKwMYR*kiS zRaPyCXcYuOkW~{EH$(&h*(3#JlT8f!GB1dnnK|Qs=0BXndGFo#yT7}5FI=dql_9bFjV0Sqf9nrw~Q z8cGBN9F~BN3grX_@rj`%^c*h{%oSn`8Z`$I1dz}+3WF#QhdrnrTpkOBH!(A2V6j*f z-pa((*V2NHw=zPRVa?1iSWAp4&e#-BG`A$0nxp3b(7+sz=|^;;d_QjttVrks0s&0K zU_wGdOhRxbT%JG1)XK^VgEhmLnHd9wF+VIwKo2zz;_H8Aps@H19vc?0xj`reBi)xP z6p+xs)lV^S;04+s{(PQ5#xS9D7-MRJRm3z0WHJ_Tu#guxXPn8vumV{eR*--Xu%-)G zkR}I*1^B==B2E8y}EaK8}8 z!uCQmFmVTuMHg^+E?jQl=abs=nFVErGqFG!y0e3r+z|dog_U^)7KJWgk@S? zXU)NZXdlEE(1RE(dkP5+Ts2{{nM54$z>0up8Wa31ER9Vq%<0B-bG(JIg{djaf@NxM zVd~5LtWV)Ggo+dVtk3*^>hI>UK?~6X|975+6C&>526A~0TqejePEo&ebwspd^TA<- z&3A+|D|mhu$VSbT4w24KR5uCDP#h}@MD|I{{+~1RNk8NO3y}UF$NdS$=lTgk=scE< zKgi;LEGG|l&d$ybjZF`ZP0NNRU-pbwcaKZkM;L9{a0Zc9~toKi+Lh=vaI9FZGjcaoF5k zV4~QbV&f9p*w+%^p7`XeztMSTDCoUT>VvbhU7iUi?y47xbk=x#CG0WI-gf>% z`XUd*A!9_8k`{6s0U-mE`C)GT1+fgVfYw6JDb26HApWmN|H0Njk+xNn+{;u{RdzZ9r~bAzzHFJQikkGyh6`Tn07!b~dR3XuoTTta8-f-xN=dd2 z3|ity+r4Tkl6&YY4jrBtAX_bJwM~^TM@AiAFMnF9)k5b;j>6bBPI6veZ2l4ziH*x0 z`y$I|7zLfYDzZP|z7#0`I&uC!?bEJLj$_RA(?CUQQ|fP~iDv;$;9B)KuEi5rE32(& z+w?8TU#hVT@cU}-J0FpLX;-w843(vBeT-I$TxAPT2^q+2JEV{1iMsJ0z%twyk0-8m zIRt#`YPfGL?DKgN2vjakr**Y7KT7jjxmn@0D%CRYE+ZL)Vq*k#dmxJni0`7?r)Jo% zbzcpXi%;jY)v!j5*Xu(kqZqh+!@xr&(Zs}IY6Ah`x!bWP;6jc?;dg!TSZ#Hm4OB^jLY}xL4*&lcj z#dv&_IEDQg1_;x^p2XPkR-iIi6{W9@jM_ms7o)GE7(wo}kP4?AZRE?37>1umQstrx zKf$AJ71E&@o@b0~{01rR22nTrgiW8gg7JQFs&`S^TX8CJixX|eC*-H*>_F|X@}^Wn zuzBd$=i?uOdONohqK-e1jU|mteLJ@QW0E*F?MY(*!B$f3dBJj$829vf=Jc4Fs6uA@ zeD@Q$^OvKelY&P1%NO4IzBJ(DO(Uqjoin{^>S&GM2Ixwc6MO@bcj6Bxs#2?)X6|^e z5ML{JSX+eqYV0nX9NTVT{q2N1UXuS;ZZ#Y=Y)F2kCJ9Dv zITzbfcx8Q=_$0^(UsAorxM6XDa*vU&7`;Z5y3UJXrniKu`+CM(+zlr&I?1+$1>J)R zax4at<#krHxlz|7{?VJXE2=$=`SUpsf@5``CSSVu4VRnF4xb&63+v0jucg(%KY*-` zRl-TWo3S@eSYd?4Wv@$85+~vo%L)tDZ*did`DC*~?yNo2S^s8?ozmH&6d8FfaYEqZ znw79dJY_li!GHAmWdDQez9`1ox4)OSyepez@lBk-F};gvFIhX5KWRSQ_V6lR7JR2C zx;^|-Zc(z<`$-+m(iP3fsits^f~$46!ep7*kyFj(O3wM*1I*Hp;?x(-1|l6$LFSPB z=_4n3m9w_0&z76BMFLNuB)DJi(P;HeC0WBqZrQ$?yc8WVy0H6Di?qHjF*~8Pc-=9r zr63Qh#05gL9s;p>dPJ=(e{buOiuHt-y^g9A8ws(D)?ATVh9pN5Ie9JlcI%FBTnXlQ z?YW8_|L%erQ8RpvZl}-yVr!jiy5wmq4X%7{6>&PkjbPc*doi2Va9=XiXuY<(Bmo?b zRHjNcxZ!hLo)ID~AZEEMCokSm&<9hH()#{a6#U}YN5efkCCkFHjJc&u3>3!XgWRl& zVfZ}I$*qbB65bb=2++`54}wW#=-Ss!)7RmSRBO@b^mJeDrdm5fR%8wFeG0IHljf9? zcf>2}RU(^v#xB9>l`pLBmgH=52tE|vaR*YP25wEs*(AAl48GooS9avr-HL301tT-# zC`fW|cXV2LhL>(@4`EhBNNM$IJwk*q(%rcrQG>~{(4IFBGSR1hNsYuqQqAPqZG>D3 z=n1m$>dOl;Y1Ua(u{;)8v3?m+)^<8Njigb*#)V%e^9cP6hMQ-~fIH~vsX#)14XiGv zjq6B;YVW-A>Qo3}f^|hk?dy)5nY%K>2?k>+2)%3z)HLXs-S+PL2~4!Unl7s{8dTsr zIPR?|JoAZwaP4QfOB__5~xe4E5|3ifs0&C zsR%?5ze zFFLKj*D3P-6FY+A8H_+&GV?XvN7~aq9L$tm+E*aWS*qEKR;T(~i=`bmCk~FOtI95} zvA2l~{J|TKlkAQ0N4R!I()vrYdXFAL?$91jl3>&OPMmmjf19wkvPoO5B}3(8bi2j- zXB(56RAl?Hi<3L?Bd_k)wcI)?T3w{~lixkeAb(&(dhxxhq$S~U8mqDs%Ivv~J`e6q_+w&xxRbRZ;_2Y|x)Nc1P2F?X?n2^vHO33iW_^c3j<&h0$w*v%{+F{q%y1|P3P&|x<8fkhSm8a;e(<}1NUKy;s{bh75f8d! zh4^%DY(#2Cx3%7ckhan@A*1_}s`agnWLKr8)c&fQ1MNO~9*rY{u`!;Ti-R+*RhFBW zI=iNyc_A{eEK+zI^v7d(YO3`c68Jn;M8qpTeK{`Hd6{b94WOP3U)OgQprEM-@UyVm zt22Mf3N?KBm(kGHU4-9`x^{W}7*I4F4X>!bQsI`Lng9=CWp;J#nkIq_<;fbEp{RFE znyIP+8ruGYdGqmu_#9MC)kOGt(lAaNsk<4fj>RO7yk8MXf)0_*WNk9Znd^)KVr$*w z<5AL6du46QqRu9$FwD`zDYKX1^vinZ;lb4(_6JU6O-H%Pw{oky^)xF++U{XwZNZdP zm#c#6H_LvlGvZ5URN%IzXAsk=k`pw!?n;=z{v?m-w{6zpWa(L_rIL^^Z zn96t7Lq<+|_1{;ZA)}XiA`HN3Ki@JO3{Y_zj>f9sJ=X8sb=C9uGUU6l@TG^H$AVDM zGyXdG&AQ^RB=-tWFB(