From 05b5813cb7e43716aeb507950b312d1ce8c6c0b7 Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Fri, 24 Apr 2026 17:26:42 +0200 Subject: [PATCH] Add socks5 proxy info --- _data/documentation-op.yml | 5 ++ .../img/documentation/admin/403_forbidden.png | Bin 0 -> 5387 bytes documentation/admin/socks5_proxy.md | 60 ++++++++++++++++++ documentation/user/support.md | 2 +- 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 assets/img/documentation/admin/403_forbidden.png create mode 100644 documentation/admin/socks5_proxy.md diff --git a/_data/documentation-op.yml b/_data/documentation-op.yml index ab97f9d..47abce3 100644 --- a/_data/documentation-op.yml +++ b/_data/documentation-op.yml @@ -26,6 +26,11 @@ path: /documentation/admin/installation/globus - id: 6 + title: PROXY TO DEVELOPMENT + description: Setting up a SOCKS5 proxy to the SciCat development server + path: /documentation/admin/socks5-proxy + +- id: 7 title: SUPPORT description: Support path: /documentation/admin/support \ No newline at end of file diff --git a/assets/img/documentation/admin/403_forbidden.png b/assets/img/documentation/admin/403_forbidden.png new file mode 100644 index 0000000000000000000000000000000000000000..475b701bba9e5a4d70eb55cddd52dc9ccab74901 GIT binary patch literal 5387 zcmc&&cU05Mvk&D0MmnMtX`zS$Nob)XBoq-51VNAzT7b|3(t>oUB1J$zK#C|`K%^I` zQKU(i-kbC$(((7@-uv$Ly!YpO=e(S=+0S=(XJ%)1W@os2IJ zkkH)N#RIXWJ%+NFpfyNtva?TxohdeC=O*vdP~92`Llg^|p~5o407m<4YG8>1eCkir>meE$wTrY;L-r zlI}2v^zA+yZnB?Bxn3lg1ZA;G&~3iM!1Y7bF+b*+4$|4*Dp64C>Is2xZ@!J9TZdrv zB*W?DbAI!U<6TD~O_;(DmHIv*+%f6bf}UUFJH*lO_kSb~wfB7+5|T1 z*{U}>SPnjC_-@t|GY%D|BbP{w1}2F#)(oFs77xk*Osa>`SF_U40NnsE1&AmV3nB#& z5zttG1_F`9hJeU{o*rmQ8N~n05;92s!8Yd$6?IT*YCx}J@d$%)bg{v?g6`+a0<6Aa z@9VqjYuu5xz&Sw8EOF)-DBi*8oCG9`mj<8%#?_1y?_lrfB8``W{JBCJz~{p-2ITj8D7ZIh5Iii|HVfM<6`j$>*R{XIdY!!H8aP#xynHx z=YszE{k2aF9{aB(N0-0V0u+Ru&%lJCaM(Y*0aDrXQE4qK9%FBygmnPS1IUmUhKtGm zx&D95{44P{O8ws`r4YYU{xEv;gOZUgAW8aUPo(=mZ zY1WHlQu~74o*PTAmeO`*m+Dga=oqeFCl2>lG-dpxNT)@5rlP<&ixU*frg(lMh?-cr zQBi@hnF#eJ-2X;U6w&|fV@47KuI#(Vl#i;{=0^#iU#I&61rJ~>GVb=7g~jzp;f^)S ze2;&QST7Hu{jz-aClaHi7MVufhKw07yffuPCU2bQKKIIO)}fwV7RtPvDxDq@;*EF+LIeZ2*M4SgEe2>=|mSf=_8%8x7HLLTzA>VO7(90Bl zoC7a^ET#LY9B($Gc7-IM3uS>=@P zGp)P$qnVjd4))g*HDNL$qjtp~wGaJU+peWw-P@Ru8Fj2(H^)?rSf$kHOGy42!!<C?>1J88`2D-Z{Fw?A2MPnEdTbfE;5MZ;%r3woyI>ed>FjNcv{lRu3o3} zu$fNvs+lu+l-u>7t*V6tL-W1%d|J0+0jBsPdKydf;4kmwy$_s@7E^F{l2YAApC%(5 zY-cBGJu3I0HQynu>2Nb*xgR|!G2EnV>5ti{?Ba&A(M5Gq^>Za%Zsg4RUoMCQ~ zB*LP>1;162(9NRIks!pKmMvt$>QHvi_9QFOB=Z5{qV>WR=Sgu^Ip_iY2^i*X*qW}(a}4vU>hgbv>0*ViNb z|6qK3FT&QOp}$v^Lqq6cS%yGy-G@x)KTy;p8a9#Q-=6bVJM&BeUKGSUe=rwai5U+o z#@km`jqFA3#`+)aty)KTNRr~!6mj*3R!^ol{7w|%mNBiXP8MMmxG8x(>aWBmkk5U3 zh7RI7X^E<0K1Z&^?#FATnv0;b!=-fW=LqJYXp&ddXG2LtdlgjPOk3mmx&=YPQ66(y z88OTuqE=0|*qP>FQVeR$Ac`iP!;)NOcd0vP!ec5`+VwlFz-&8|xzMl@fuH6+?iB5& zwQ`FH27>HCc+f=*6_d!N+JJ^NI+~;5(Y|u75NbA-4ptG%FvhvQUcyrb0Y(jtr2uxji`~d>x&2pda|Xy*dM--8;hQ$BubHxCwICaK!?SOOxXALr zo#XXNG$Gt{m7A&}oYt$%+>MNqiPlTS^XH<{J9};3m}n7L{Xu4zYEZnyj%SPeN`H># zyLuez1h8VSB01Y7fxvynT55-xr7>EkN0h9H&TkCdS4HY}+6D9wO?MACy=Q{2(0`?Q zah!8%&)OD7Dv^I!U}ka@s}2?Jvbr8LReiXJSt;e#tipNHZ zh^v=f7CVLAP86T*G(NSSX5uIlB2^8*uLtE6&;sXL5>Ip3xH<09t$`1JzI20hE2NJ? zGia>_aeFWYGGES)m>B3K>+@hJKx80+MseBkKr#g9yw;cBgz^fRv2E5_OHDTP(Qof!+?C z{Na3Dh1w7Xob{xYf)wMt${Draxb{7JSG(`UJ~_F(Byx5y_OYhyc911+{cI7^R3%25 zBKX?Yo^fXpvTDO=prutIEb@R!^8r^Ha7*g5f4)E=`sPbh$2Bv?5;>dxnCR^w>4QV? zQ+WzC#mE(xuTr6xVJ3I>Cp^%LEHBZ0J+Zv%JP&ohz}N-IaSZks(|j$K@%XJK@(U?G zdt7=}&Bf41AJP0{S?X5|gN;iOQB+E4lU=3wUVA=O$Eq1J3%hM!$|f07!%R#^f+HR4 z5|P>4qt{%Y^y)hcjtNP6&s6)}af1NEhaliluXWuHP)y3)k$^a97<+Axr~R!+E=%JMd^ zE)RngrDau+zO9EOCE8MI#e6@EJGLGTDsN<{7~s?Mx$wb8vkPyJ^@XW7$8yqrZFgsM z2@%%`712tOm0j}lmo8+}I1uUpfB6qyCB;iqO;?jS`zo|Adcxk!lwn@_Z*q#WGu zi;Sk&3`)#Z$Pg6U;)0MSwq^RSfRsAw;(}YY^5a>rDLPtjt2b*o3?yp4=hg8cm0Zbv zV?H=OLaI}yjzwc7IGo=FOc*bv$$1?quk3jP*_$E39%_czBIm3RL7ss|AFmej3h0L| zgsR*7*GA_#`(?WcYZks2=`CJrKxfrRhJCkqFr->aU;OYbc?uU94ZFR2w$JO57H=S< zj9D@@uEmO%l0@AyjfCptjx|Yg2?W7hf1RCn&B^VLTinHD?vCi*I(ul0aEI#y_O&+a z&2XA-49MFnk(!4pPHR24;E)_yjV;J^e2kjCcv&z^cc1F3{$e}%l-0p}oTmAwlOzL? z(~+MYum&Fa2g>i~6zW@0D_lzG>JC1^VxKv-R&&$Z!w!W+O^sPDV?AsgJK!8uA#2@k zwV8FRu`V=SO$|bOMOCxl7M3#?HPjb$+84P`Z5{BG?%LPbS)RUW>Ua&v%z6!of$e_s*~%?T+#2uqkO% z`ARL+xsQ>+5f@aP9zCBTdoqWsFY&?bG%_4>LM|fhw=S5?^>v|M{UYUTt|uD}s%67= z-~3gVH=91-rYXDY{DTQ*KOOQmH(JyA%8&}cxyg^)=NA$ zQKcSfqSs%F;~KEi)asI0>#W>F+@b1 z>aC_OU2?JhkB2FnhkE{?bRL+w873@~iaqJ?^Jd3(uX$+}u&B5AUryp7h4G8R80`&y zg_Vu5b9^pc7^fg(wSr#_lv;ip*XdR3V5+x($ur~)h%9SSXEbzN8OYPKYHNMh?4?%0 z0oO5)i})B)!49Ki2&CVs4v&hwb(Q-jkjc4E*1;6vM3{sM9ztzZieKzT=)oAHAGdb9 z=~_@GpD7{YqM{_(SG3M7EJ^C1d@vpfk4a-76$y~-h=5;W3#vO(N0ly;Gr`sp> z3Ll=bq6=L&-^vU|_F$?4srE}}CZ&w{HtEr3>KZ8sx41h-E7OXz*gXbDaV~!1?MZO^ zQ9~ratK$DMYca;WDIhUI9Hgg48?BAmc(i zhPGw#Thq6or4r0XnsC5^6hF-95LLIUP@&WWk~Amdt?_D?F8VMSPY&=Nn0Qcc)jY(8 zK$Tkk3T*(gZkc5peM_eDv&($*wduiG)f<&S{wC~;^*08PbalSB>4l^e$2d`ZkG+01 zA?X#cDGM^!?ld{PfVLBhHoQ~jEWUuj|nH^qU&LX@FaI$41xP{c9LW1zPrm<4_T`Rb1u@+ZAQL612vT)Xp9VSTJJr^KR_evSGB&&>BpoYEig zYY=Vlr<227Z2ODrW%zCLWO2L86W+UBe0Br5_pGMxrpYFamSIuA%a(XU47X}Brhgz$ z2fN&tB?jEiqQm!=H)=Pt7djGCjx0V$2#5DI`1vJEx$u=cPK*k+nO12gi#@GzU$<>v zzDcF3Fi}L+`u+wrw@L&&kV8EiD1LgM{BhCduH`_h#hQtb?C*Jv!cNwC zS{(-R4z7)q=6P&RirX5e|iom4`Uw_|1O*NlC zhyucwj^*CM16xwpw)-m^Iy1kG0Ny*{bHm#P@Mk1<{>kn0z|O1H45m2;HcIj6JUSqF z-S+dgUITz4GIvKn9EkL+4S7a+F#x=#)Ah{)J}P7mOyo3&0stbG*gKe;Chl9yuQAV2*Rp6LzCP8`#yo|HWnwIA*tVzj_zt44!`#Q&YaH1XQ(8{sU64 B*t`G$ literal 0 HcmV?d00001 diff --git a/documentation/admin/socks5_proxy.md b/documentation/admin/socks5_proxy.md new file mode 100644 index 0000000..11a389e --- /dev/null +++ b/documentation/admin/socks5_proxy.md @@ -0,0 +1,60 @@ +--- +layout: page +title: Proxy to Development +permalink: /documentation/admin/socks5-proxy +--- + +## 403 Errors + +The PSI development instance () is only accessible from restricted networks. Connecting from a disallowed IP address results in a 403 error: + +![Example 403 Forbidden Error]({% link assets/img/documentation/admin/403_forbidden.png %}){: .center style="border: solid #ccc 1px; padding:5px"} + +To solve this, you need to connect via an allowed system. The best way to set this up for operators is to configure a SOCKS5 proxy. + +## Intended audience + +This is intended for operators trying to test the ingestor against the development SciCat instance (). + +## Prerequisites + +You will need ssh access to an allowed server. This will usually be the ingestor server, which should have been whitelisted by PSI already. + + +## Start the proxy + +### SSH with the command line + +If you can SSH to the ingestor at the command line, starting a SOCKS5 proxy can be done easy with the `-D` argument: + +```sh +ssh -D 9999 ingestor.example.com +``` + +This can also be configured in `~/.ssh/config` so that it is automatically enabled when you connect to the ingestor: + +```config +Host ingestor.example.com + DynamicForward 9999 +``` + +### PuTTY (Windows) + +If you use PuTTY to connect to the ingestor server, add `D9999` in the Connection/SSH/Tunnels section. See the [PuTTY docs](https://the.earth.li/~sgtatham/putty/0.83/htmldoc/Chapter4.html#config-ssh-portfwd) or numerous online tutorials. + +## Enable it in your browser + +Your browser must now be configured to use the SOCKS5 proxy. This can be done several ways, but we recommend the FoxyProxy browser extension, available for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/foxyproxy-standard/), [Chrome](https://chromewebstore.google.com/detail/foxyproxy/gcknhkkoolaabfmlnjonogaaifnjlfnp?pli=1), and [Edge](https://microsoftedge.microsoft.com/addons/detail/foxyproxy/flcnoalcefgkhkinjkffipfdhglnpnem?hl=en-US) + +After installing the add-on, add a new proxy. + +- *Title*: OpenEM +- *Type*: SOCKS5 +- *Hostname*: localhost +- *Port*: 9999 + +After adding the proxy, make sure it is enabled (the FoxyProxy menu bar icon should be colored to match the OpenEM proxy entry). + +## Testing + +Test by going to . diff --git a/documentation/user/support.md b/documentation/user/support.md index 187ab3b..e735b2d 100644 --- a/documentation/user/support.md +++ b/documentation/user/support.md @@ -7,6 +7,6 @@ permalink: /documentation/user/support {% include documentationStepper/stepper.html %} -_This section is still under development and will be delivered soon._ +For support, please email [scicat-help@lists.psi.ch](mailto:scicat-help@lists.psi.ch). {% include documentationStepper/forwardBackward.html showBack=true showNext=false %}