From 725bc4222bb496544dc2a525b5a3e69992f1d79c Mon Sep 17 00:00:00 2001 From: Kato Twofold Date: Sat, 21 May 2022 17:41:43 +0300 Subject: [PATCH] Updated visuals + New banner * fixed .env missing variable * Build script now builds to all platforms + ReadMe instructions for running --- .env.example | 6 ++- README.md | 64 ++++++++++++++++++++++++++++++- build.sh | 6 ++- static/img/banner_how_to_run.png | Bin 0 -> 9418 bytes 4 files changed, 73 insertions(+), 3 deletions(-) create mode 100644 static/img/banner_how_to_run.png diff --git a/.env.example b/.env.example index 36d579a..1b7bad1 100644 --- a/.env.example +++ b/.env.example @@ -17,4 +17,8 @@ API_BAN_LIMIT=300 DEV_MODE=0 # Maximum file storage age in minutes, set to -1 to disable -CLEANUP_MAX_AGE=43200 # Default is a month \ No newline at end of file +CLEANUP_MAX_AGE=43200 # Default is a month + +# Maximum pad file lenght, this is in characters, a character is one byte. +# Default: 524288 ( 500kb ) +MAXIMUM_PAD_SIZE=524288 \ No newline at end of file diff --git a/README.md b/README.md index 8928172..1261fec 100644 --- a/README.md +++ b/README.md @@ -30,4 +30,66 @@ The `.env` file contains all of the available options and you should use it to c If you need any help with any setting you can always open an issue over on github and get help from me. -If you are barely getting started with hosting your own services, or even Sys admin stuff in general or writing code my suggestion is to just copy `.env` and leave it as is until you get it running with the defaults running fine, afterwards you can play with it a little and who knows, maybe even get to learn something! \ No newline at end of file +If you are barely getting started with hosting your own services, or even Sys admin stuff in general or writing code my suggestion is to just copy `.env` and leave it as is until you get it running with the defaults running fine, afterwards you can play with it a little and who knows, maybe even get to learn something! + +![Gopher](static/img/banner_how_to_run.png) + +## Docker `(Recommended)` +```bash +# Get into a directory to run this +mkdir ~/freepad && cd freepad + +# Copy the latest .env and docker-compose.example.yaml files +wget -O docker-compose.yaml https://raw.githubusercontent.com/JustKato/FreePad/master/docker-compose.example.yaml +wget -O .env https://raw.githubusercontent.com/JustKato/FreePad/master/.env.example + +# Edit your docker-compose.yaml and change the DOMAIN_BASE environment variable +vim docker-compose.yaml + +# Edit your .env file and change the variables to your liking +vim .env + +# Run the container +docker-compose up +# Run the container in the background +docker-compose up -d +``` +## Distribution +[Downloads here](https://github.com/JustKato/FreePad/releases) +```bash +# Get into a directory to run this +mkdir ~/freepad && cd freepad + +# Get the latest distribution from https://github.com/JustKato/FreePad/releases +wget -O release.zip https://github.com/JustKato/FreePad/releases/download/main/... + +# Unzip the release +unzip release.zip + +# Edit the .env file +vim ./.env + +# Run the program +./freepad +``` + +## Building +```bash +# Clone th erepo +git clone https://github.com/JustKato/FreePad.git ~/freepad + +# Get into the directory +cd ~/freepad + +# Build using the script +./build.sh + +# Copy the environment variable +cp .env dist/ + +# Go into the program's directory +cd dist + +# Run the program +./freepad +``` \ No newline at end of file diff --git a/build.sh b/build.sh index 52b2539..f00ee0b 100755 --- a/build.sh +++ b/build.sh @@ -2,7 +2,7 @@ echo "Building FreePad...\n"; echo "Removing old build file..."; -rm dist/freepad 2> /dev/null || true +rm dist/freepad* 2> /dev/null || true rm -r dist/static 2> /dev/null || true rm -r dist/templates 2> /dev/null || true rm dist/.env 2> /dev/null || true @@ -10,6 +10,10 @@ rm dist/.env 2> /dev/null || true # Build echo "Building executable" CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o ./dist/freepad . +CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o ./dist/freepad-arm64 . +CGO_ENABLED=0 GOOS=windows go build -a -installsuffix cgo -o ./dist/freepad.exe . +CGO_ENABLED=0 GOOS=darwin go build -a -installsuffix cgo -o ./dist/freepad-darwin . +CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -a -installsuffix cgo -o ./dist/freepad-darwin-64 . echo "Copying templates" cp -r ./templates ./dist/templates diff --git a/static/img/banner_how_to_run.png b/static/img/banner_how_to_run.png new file mode 100644 index 0000000000000000000000000000000000000000..8d18d2e4f3403b97acf734398644292b308fa235 GIT binary patch literal 9418 zcmeHtWmHvN+ch8}Dcvn82#82G(kUqj(j7;-1nF+2Q=}U_aOhG(ICLE1&?(IU3CVZ! zJh!)g-_Q5=JH~>+SnR#_b{Ev;0reSXWqwD%`x3q`_-qXhibC#9# zG?>=^{;GDvYeL0fYh@*H!X%9$RT=}o>%|95yS2xwDX$X;ZcgvN_c>1N%Ih;KilmQy zB8a$>~%C5*cf3LNAcIb`S>hz;MU_VJ#XV6V`pB_T5 z=8E&~@+tG>eA!~(Co2TQc+MK|0x%rq^<0pUun6vckjLiVUm+pUAt^{pYIz#&Wj#nF z(mw6s5?B*h%U?rg#E^gam5xmkPX?do^HS3#e}#>ko8HMT4S&r}f4bu<8RR5Jwn$b% zMb!^31d`6_CP)CDU$;w2xAsd_C*Mpiidw}!yIwiaR`c^+e0N52p_fMV{MsWVu%*W+ z0SP1icgueq@HN@%0bxvMSAikNoSjW%;y5!h!FdSMt=OSD9WntOGA%)MWUp~{kK=;e zj-9Iblg#8}dS}%L)Ui+`56&^m58>U8z3T|+^(E)Tr4v|%syA|6@gd4 z0RL@jgpO=9^oP-b!zJ>rC}At37);6Z|NIXafQarTYgb4b5gA381PbH7E#4M2)0;-q zVU7y-Ptfra1n4hCn308=e?CE`sX5#ob6WcEE$RfUhcj{rGA0EbB_$Mu$WBHwlAw(d z{!+?gBMugpReBUq`x&OssYMs2UB{qW&n)Urv;5NTjLXsGW~lt-!$Ink{u8(0h!A-? zYK%jumQbb8W+o=8>HCA241p(wUL(h3gkm}XK>uVF@bi%bBGqtbaOT5rMB^otQCVrs zzV`P2m4zYDHE!1`sQ>#$WPsYj!XJ${8pf=aLU^S@+T=gLgdKa)We!*f5y)zMSdf4lW92qcWnNs zpXonE^-7IuSyKNAk1k+>?&WtT-joE2@fdrev^0x#1j_?ioyW>sIes^KLz#Ua=jK{E z{1CT-MJ^VLZ9!k`HpK*e&Ko{a#r#1`Bf($)S@*{k?mYR>=e7pDlWx#HL55}zU#{kf z;eKLD^OMrSqt!U^CLuI;**{75F)t|~Qn9U>lt@x~RJLu!MZFClv#4bzhhV*eUNy3t zA8)+*smN@mKF#twIsYBt73N7B7TP~nkzTRtJv~^fz$Y|^!$j2~J+^;PS;9fVo+J!& zE7h+mZ237QXMPy}9tD@_ub8hC0mN0=_2u6a&mHw za$WVuhAqXXMwwRSdf>=JE~6fGU%OoA(uHHLo7dU5-*%jrI+lxPjhX&DOyN6w_SWQ}61R7;J+BUPb0kw9E%G;Aw>z+95TC6N;H~TbR7bSjBHSz1U1{$ot zil2?}u)-7dr*4pUj#v_V2H*a~duCse7i`*WT)r2UcKqd7q>x2K)tjPFgUO1Dfz&pE zq#Wefzu=)FtbQdCn{o73(jYVdPt^0UxaIPcyHNU}L;YDI0h8xFIQ|oo zN56|!-V3O9J|)y;>pIbQr_dZDD*DCB8Pnztf!pb`P2z44?WXIUK8SR#@qW-v4)Y%hOF_0Q1TuWMl9R2(Fmd z<7N-7{&!X*VdM)1)Z)k0gzjO~$M3*EACEWvu$y73JVW^x_r4+iU9|K0?=Fil*l1}1 zf3bk>SHID!%_~Q9lBOpWm0wOftAM7+)y)$us;LF)|n7 zVXNoFi#5QlM+c)Qh^ezN90*3GV$}PIje5=xA}&dpH=#P@w;74)hwQMANWrm@kqcsbqY*R zFo}D%S<5emw;If7&r@gjYN{(7B!1<{$hlGj>z-8JqtWTbV5M0Ff7Xk!&6w^fnhdOn zCO-+W>M|R*Jef@SM53N6;J%wrvSHU#EAz$UAmDf1%cCJLzSU=WB;Z*c!lqehK7H~H z@+*zUt54VLQ~`xCJ`lCPY@(p`(lyzHOPt2yR`*;WD;G!`(Zm~eY&Ao=e z+6^?fOiuDXv9sCq6?Owvpt|2|sAWL8l7#o0R2OIkXU4GwJb{JamT(E;Mgvf1hDvuT8-tr_T5Pj;+oZRniIE%SiE`hCR@;&!l`OUNTJR)NyC$b zisEkKgag4g)i}(5mPy_N*IKxo)2%>o?n>Ri3f-qFcs0k6ir&j>6Xp1;j$hGGg%7Wq zYAC9FhaajB7Y$*n`E=y=!f}7~{L<%v^vMhYQ6h*M3gZ$tN*FHn$1Nj2Gl~<73W|63 zBvhOLGEMkPX}x5xS{#}S$Euf^O!U*l-xiRp#%ze9XqRe@tehut=qoxtW;@sw6m+^u zq!Mt{T~fJ0^d1Tha+?{1KQ&DB=cjVI%}lQo+s)j%Kcu;GW2)4e`{`QfJ=myY;RJO{e8~K5Tkd%&;7x_{v~LgT{APRr7LKlxL1Fr^zt)bzS69f7vkV z_KS0|D?dL4wpDpyE_D>UF&QB*fSdBfQ%Jk=cl&=E-&&+FN_~r zo#(Zf^?InEezgS=T2Hm5&E1w|6l7jV)Pgk%6s=LfW<^l*BP*A+JlsOG>yBO~4AcNw zRuZ!8tP335z73V;-KG&ke#@0n_FC;#S8t56v}G92c9r3J1p^TtQ_#UdQA>MnNW@S9 zu(geyltN}zHq@906A@Urdxxk)LFP zN0=X9MduHWRPM~{?KjrH4ZsC?`o~fU<{qWwka%`HM*d)hcxL z?GxOu?3KgAa5*FgSa~i3B7AROry_$$Hwdzq-uED{NZ>W4ouXuPH@o{a&YL8UcC~!R0rJU7!ZXRxqI=LwYMBow)`nZekXZ}By1KF3Fvw28`(~~NvbfRM=!J#i0h9M z7Slyn8m?S^{&4CW?EARV9i^C5O00|!<2LkJ4m5thGl(}f^nxr2W3??giJdPUa-W_g z!{GI+3xgbv3iuk9u;+I?x{H{p9uhJ>PGu8z1Ag?TI2P6VEJG;ti?Wn<)l0A?ai`8_ z-ifF>NuOVmn43l&BF>m0ru2OJ zkb$`ONW)~D2Z~8x(*=y{ zrq#I{ZLj=IDS6LyqmtctwUk$AmSMcJS?mQqwn5;p9i@ZsFpka_37v$Ej-6}{4mUT$ zy#*QtM*+)kirSRbfo1#kZV>8VB+giL!^wsY%+x_Ap{k0j{_3=Ogo< z-@>dNwjBiU<6s;+yflIb(|#Rwv+lK^vZQnW)Ox~~p1$drzCmYC-O*hsT^D2e^&9Ee zL8jk$Fyl%<=g+w9U?1dZm-CbS*4Me|L-L$n3K$+Pr*f??%e}?DYVwK-P4B4JAJ12b zr3Uy_FeBbCmI^szv5V<9m2pIHGd$`j(h8^6w^bg~2Zf+O+WLxG%#$%e;l<-1+%LDS zCp8Sq#c?Ol$5@QbcKUlzG;H!PA%jsVk^v)|^oJsfO^4sG@Z6U*PEDH0AIaChZJ+;) zVc!}Ps+VHDwI53(icgSn@@0SxH(YLRx;un)-f`n+)~!mUy!jFeAwAX_~p_P5+DPq4r%AKob5cwE2UWGh0kTjEj~mL z7DBCZhTO+g6cf`bhMvfpo|{?{M=ncUN{{jVXID__sLz(Gf4b7MnW}DtjuPN<+0C(y z*m+=u8v|igtm59j-k!R?x4HX;ViFd}NO@0Z^-)(JVbQ(plu%nZMK4p}eQdc*adiE8 zI$MN~!z)q(M|IR*cH_fBl^h5wYrOY~?fw2-q+qM!=>P-+#XF@KinJ-lS@1Wk$;R={ zv(20g`-uk7^m#;0oWWWR%YJMFIr=>AMDo5lE{2@4^Yz6Z{xES3KVoi2XKYC?u7O(z z5Ch~X05Z%vdN6y^>LcowO9FoK!Jb~-ee=?ma>61WXQ#efWVpOsXx6=26Z!=`$y(F} zT{UJ2j*fFLh_xIbL-vah{-;FY?Yy=bxcto~cq!rUNT2LKg5<~4FxOb%G&|~hXAs1Y z4oR)dkqx1tL5;PZO2_f92=i%tgPZ_XwM)rpI!L{>b| zXY!)tt|-lLm}x2kI;Sf8aI5a&e&(b>EJqo9hr#DbXF=BKQKT!vrtEE>mt{Gbs}GvV zVA2jJJ1h7O+9e;-o~__-3Rtlse#l^X4Ds#yOpvkyr%C@afHcWAgdQ3$9bOm42s4!T zt(3?jZH`5EwjnH#QnEku&av{o-gYeY0;#3uapvjdV zFGGJ~T~X>!=^(-zJIhMo*`k+qpJq!yhtsA|L;m0;$%Yi`ijMSRC5njJstHin5FUBK z(z+}w%RF8eRqvaY2A2fNZ>@+UU@dfmrAYI{FfjOEXw1?YeA=eVL z&kqQyv+DyLqq{SFWW5ShR=C4o3i?cEmf~?sJLS!$W;Ddk?(=y=%dKvzyCe2anoewO z=jmSxip1l+Zdx`VN6iNrDkxZErv=yaKH5-UY|4tGY>RmABdFVC?l8g$aL3$dSd+Nr z93ti4F|L=%tkMDr1o!3PVjibH`P#bKz&Tp(F1p+EuqjlU3~TJhn5sP|neV0R+6$}t zpgsD7)=Qh`gJ9K2yy{5NF74><^38fF-wr9`AN1x+7WU3Iq5=Hs_3qS1_kvbEqDV=x z`P!v1h~9`uInwKV8ZDcdbKZA3QGA=}Q5)IqS=FcKHuO|4G|}gv%(XyGg!k#w;5L49 z=-do+t(gq6k(U-X+Dxf(of85d9(6RMCOE`GUJTui=nnchDyONE{mD3Ley1t+HIh@h z2ZnL;Nb1T%dTqxDrq}EsblVuda{WT@W*9gO7BAX!9J}b}Cx5!TU}P+>b3g*AjIk6s z2#+Ffh)=XFwDRYU#mbg4gHclvV(1KQ8AJ#4)bXk>M}DwTnjj5uvpXKHlA>Dl@M}-q zARF{~q~e38LR;uQubyP4NyJjTm=@6GLI z_yTOtGY3!s!+EbR%0dE_(3Y{eQNYcH``1NuF;@Ak(cA4>JsuZN$|8n9dG11jt^yK+SPYAv!fBqWVQI5JO1cu_qzR)Lnd29Z2U zkY1Q@bF)G>MK?ayeEh}3yNWs#dB>n!pSoLc)$_rxNpn+2y+R>nm#?ry`a_uDD0a24 z*y*>DLXh{_7S$n5*v_IS5AAxXRx2Lrd%_ujizmX3O za_A@fDN&x#W7|?f7MuiGlA&h!0pXe^<{>jp79O8?Jz_x}TRccOgRJme;ZhaX%{i}eCMvBFqzKaAb`wrRn z?A?5CW-_Y_4tp2+Xnn<;O)ooBv1QF<{Y(gS>lYSy@X&feB8Mbm=OYfLEv-$eZ^CPo zT#5_Wo_o?#vMo>LE3{4F!^>1rMkz&C$&^xdVTE*X!-xax^=Kc2Z1Z)jVQd~H-Qi^r z?jm!8Xcc8ktZc4jeI=;nA>wu)o|D=XxY?*_1tx_Hk(k#%dp!&Y3YLXnB^mh~!6isG zNIA|IkQL5T0U8q2o%Iu;Ea<%^J^kVE!nL_DD+o5$EYIfM>F8y#op?VWq*JglcUb(B z1`;0@yZiF|#Wlb!WuWB}Z!+a55f`3vQPEl*jccV{rjuxO>)1|mrokU)p4Z7YL4*kfT*Uzov0B#dO(sk)*I|6Ic2R|kiM=po;;1d)@UbTePPQl4m7 z;d&g*vGl5Cejs4Oei(d5nDXCTlH4DoY&+SIo@u|0&kK01Nvu<)F8K0o!eDZpAs)S_ zPQ@JSo^b8Rdy4^OurJ(j9M+I0S@1Gm*^Mt{O>{y)uBL zBmzv5hcgTh96U~XXU`u@za|b`jTNrq@e-Vfg&ffd?gn>%kVRS$HfQqwkpM@L!Vc=x zlfIfJN72W&CVEyBU_+;*UXY$X3wGS{ z$fn_BTdkzQ7Mf%Pt#DBF`(HVE=D(gD$9Ok;gW6*q)pL~7Z3tZM4%st2DgCi{USH(e z#r1&mWpY#d+*ofaz0l>nPu-f8D6ZJYh}EJ#KzYd@KAHI`)zmt@8;9y6^oj9vyqUvv72TkFA$MT2zJ$LGz}8D{K<}wAxE8g0^@z( z?%F4$iRUEzon5D#|9;lP+C3*kxEI~(fcOoch9f8O!t)}u&hr7yTUD>+;^9rOnq{8} zak>Kk)jT=X#*wn&f}oel56UmbH*7`nwN~EKi*o(C#LVb^y)EuoiwJ4GcwjYJM*ZPc zD``&@HI0^8(1JW)`Opu7pJMgCstfgD*Z2+@)gdT}-eO^nIDj;7@CC?$I$Ol7x!GMd zd68;I^w;>z(K_jI{x@O{#>-NOhS7X}*egALDl>`M4sCWmOlRe{@FtdRem1eInmX&+ zG+U)-1j4>-ub5RbbEP0!*jnF2AofG;HB<`k5UkBQS=}O*-xpkV&r6Ckx(&p#o+}ml z+(6TdJFdb(FO5}BsXrvK^MBV^kC=yWT<}Jif1-pPyqtM=bZkM3K?vtDXvPa-SjeP< z#jBxT(QLOO5AU*b#U(4y4v*Y0^MVXsHQT%$co6I0E0TjnS`LeyARBiY$^sjlmTi(* zwg#I~+r@4}&)a70K1$F}7}S^6BtCCB$Xh4wqo{cTOwcO~A`QP(vso=_$K#I(+9Z`I zfvJ;O%HdFslP~%os%c;5zB{3q&imF_KlX3yCFxE;Z$kDP+O>%N5=}R+E88Oj!j8Dx zR{m*#ln%Hv$m}f{2gNN@?mB=FwKZQ9^@h7m^|z}cf$~@hNMBV6Y;nvfS*a_$BmSvb zt6Xd0|FeP^B@kr27UVn^SV=wm_R}O$#O#lP_V*}z4QGgcKkgs(GqyaAMv&gT>>Kb= z0Ltmzw*U>k4pzXD9iN=S`-Qz{>Msv={VqT+g|>5_N~&qUX~<;f+1bZOGSBRxHUDM- z*hmBb6BVfHX>{3KZ%xRVfxNDG&9wFI#jF3<11pj4_*hxRV|8S{5zS;Gm@Sr+@q7rH zQjr4ib0tg5^YUlw{VAhTXPM%+W@A15v46!ufRarVcjuM@Iw)zM$QzER5m7Vo%x&A8 z-RM8o>>OQ(gB?FB8269Cc!&Xrr8!R+ivU02w;cxp>cKVW*(Fe>zgrH_^|MdPnd0Az z7?;q1JO6L6e_#XQvHk=<;}(mxNT fL#{`^67QOj{S^J^`W*N~21!9iRk~8jIPiY}t5F~# literal 0 HcmV?d00001