From 13f210746f11382e0a87af0cf4ddb264f03acfcb Mon Sep 17 00:00:00 2001 From: sundowndev Date: Wed, 27 Jul 2022 00:01:34 +0400 Subject: [PATCH] refactor: docs website --- docs/contribute.md | 11 +++++---- docs/{ => getting-started}/formatting.md | 4 +-- docs/{ => getting-started}/go-module-usage.md | 16 ++++++++---- docs/{ => getting-started}/install.md | 0 docs/{ => getting-started}/resources.md | 0 docs/{ => getting-started}/scanners.md | 23 +++++++++--------- docs/{ => getting-started}/usage.md | 4 ++- docs/images/0e2SMdL.png | Bin 0 -> 8364 bytes docs/images/KfrvacR.png | Bin 0 -> 7928 bytes docs/index.md | 17 ++++++------- mkdocs.yml | 21 ++++++++++------ 11 files changed, 55 insertions(+), 41 deletions(-) rename docs/{ => getting-started}/formatting.md (96%) rename docs/{ => getting-started}/go-module-usage.md (76%) rename docs/{ => getting-started}/install.md (100%) rename docs/{ => getting-started}/resources.md (100%) rename docs/{ => getting-started}/scanners.md (95%) rename docs/{ => getting-started}/usage.md (84%) create mode 100644 docs/images/0e2SMdL.png create mode 100644 docs/images/KfrvacR.png diff --git a/docs/contribute.md b/docs/contribute.md index d51d4a210..2701b1398 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -1,10 +1,11 @@ -# Contribute - -This page describe the project structure and gives you a bit of help to start contributing. +--- +hide: +- navigation +--- -The project is maintained by a single person: [sundowndev](https://github.com/sundowndev). Contributions are welcome ! +# Contribute -!!! tip "Want to contribute ? Clone the project and open some pull requests !" +This page describe the project structure and gives you a bit of context to start contributing to the project. ## Project diff --git a/docs/formatting.md b/docs/getting-started/formatting.md similarity index 96% rename from docs/formatting.md rename to docs/getting-started/formatting.md index 2b7eb7fe9..1383c7cf1 100644 --- a/docs/formatting.md +++ b/docs/getting-started/formatting.md @@ -19,11 +19,11 @@ E.164 formatting for phone numbers entails the following: For example, here’s a US-based number in standard local formatting: (415) 555-2671 -![](https://i.imgur.com/0e2SMdL.png) +![](/images/0e2SMdL.png) Here’s the same phone number in E.164 formatting: +14155552671 -![](https://i.imgur.com/KfrvacR.png) +![](/images/KfrvacR.png) In the UK, and many other countries internationally, local dialing may require the addition of a '0' in front of the subscriber number. With E.164 formatting, this '0' must usually be removed. diff --git a/docs/go-module-usage.md b/docs/getting-started/go-module-usage.md similarity index 76% rename from docs/go-module-usage.md rename to docs/getting-started/go-module-usage.md index c790e307c..b2881c519 100644 --- a/docs/go-module-usage.md +++ b/docs/getting-started/go-module-usage.md @@ -15,17 +15,23 @@ package main import ( "fmt" + "log" "github.com/sundowndev/phoneinfoga/v2/lib/number" "github.com/sundowndev/phoneinfoga/v2/lib/remote" ) func main() { - n, _ := number.NewNumber("...") - s := remote.NewGoogleSearchScanner() - - res, _ := s.Scan(n) - + n, err := number.NewNumber("...") + if err != nil { + log.Fatal(err) + } + + res, err := remote.NewGoogleSearchScanner().Scan(n) + if err != nil { + log.Fatal(err) + } + links := res.(remote.GoogleSearchResponse) for _, link := range links.Individuals { fmt.Println(link.URL) // Google search link to scan diff --git a/docs/install.md b/docs/getting-started/install.md similarity index 100% rename from docs/install.md rename to docs/getting-started/install.md diff --git a/docs/resources.md b/docs/getting-started/resources.md similarity index 100% rename from docs/resources.md rename to docs/getting-started/resources.md diff --git a/docs/scanners.md b/docs/getting-started/scanners.md similarity index 95% rename from docs/scanners.md rename to docs/getting-started/scanners.md index 4de8eb3a2..c368f2c09 100644 --- a/docs/scanners.md +++ b/docs/getting-started/scanners.md @@ -1,6 +1,6 @@ # Scanners -PhoneInfoga provide several scanners to extract as much information as possible from a given phone number. Those scanners may require authentication, so they're automatically skipped when no authentication credentials are found. Note that all scanners use environment variables to find credentials. +PhoneInfoga provide several scanners to extract as much information as possible from a given phone number. Those scanners may require authentication, so they're automatically skipped when no authentication credentials are found. Note that all scanners use environment variables for configuration values. ## Building your own scanner @@ -11,19 +11,19 @@ $ phoneinfoga scan -n +4176418xxxx --plugin ./custom_scanner.so ``` !!! info -For now, plugins are only supported through the CLI. + Plugins are written with the [Go programming language](https://golang.org/). -To get started, [see this example](https://github.com/sundowndev/phoneinfoga/tree/master/examples/plugin). + For now, plugins are only supported through the CLI. To get started, [see this example plugin](https://github.com/sundowndev/phoneinfoga/tree/master/examples/plugin). ## Local The local scan is probably the simplest scan of PhoneInfoga. By default, the tool statically parse the phone number and convert it to several formats, it also tries to recognize the country and the carrier. Those information are passed to all scanners in order to provide further analysis. The local scanner simply return those information to the end user so they can exploit it as well. -=== "Configuration" +??? info "Configuration" There is no configuration required for this scanner. -=== "Example" +??? example "Output example" ```shell $ phoneinfoga scan -n +4176418xxxx @@ -40,13 +40,14 @@ The local scan is probably the simplest scan of PhoneInfoga. By default, the too Numverify provide standard but useful information such as country code, location, line type and carrier. This scanners requires an API-key which you can get on their website after creating an account. You can use a free API key as long as you don't exceed the monthly quota. -=== "Configuration" +??? info "Configuration" | Environment variable | Default | Description | |----------------------|---------|------------------------------------------------------------------------| | NUMVERIFY_API_KEY | | API key to authenticate to the Numverify API. | | NUMVERIFY_ENABLE_SSL | false | Whether to use HTTPS or plain HTTP for requests to the Numverify API. | -=== "Example" + +??? example "Output example" ```shell $ NUMVERIFY_API_KEY= phoneinfoga scan -n +4176418xxxx @@ -70,11 +71,11 @@ Googlesearch uses the Google search engine and [Google Dorks](https://en.wikiped You can however, use this scanner through the REST API in addition with another tool to fetch the result automatically. -=== "Configuration" +??? info "Configuration" There is no configuration required for this scanner. -=== "Example" +??? example "Output example" ```shell $ phoneinfoga scan -n +4176418xxxx @@ -176,11 +177,11 @@ You can however, use this scanner through the REST API in addition with another OVH, besides being a web and cloud hosting company, is a telecom provider with several VoIP numbers in Europe. Thanks to their API-key free REST API, we are able to tell if a number is owned by OVH Telecom or not. -=== "Configuration" +??? info "Configuration" There is no configuration required for this scanner. -=== "Example" +??? example "Output example" ```shell $ phoneinfoga scan -n +3336517xxxx diff --git a/docs/usage.md b/docs/getting-started/usage.md similarity index 84% rename from docs/usage.md rename to docs/getting-started/usage.md index f8be689d5..0fc18ce54 100644 --- a/docs/usage.md +++ b/docs/getting-started/usage.md @@ -44,9 +44,11 @@ phoneinfoga recon -n +42837544833 ## Available scanners +PhoneInfoga embed a bunch of scanners that will provide information about the given phone number. Some of them will request external services, and so might require authentication. By default, unconfigured scanners won't run. The information gathered can then be used for a deeper manual analysis. + See page related to [scanners](scanners.md). -## Launching the server +## Launching the web server PhoneInfoga integrates a REST API along with a web client that you can deploy anywhere. The API has been written in Go and web client in Vue.js. The application is stateless, so it doesn't require any persistent storage. diff --git a/docs/images/0e2SMdL.png b/docs/images/0e2SMdL.png new file mode 100644 index 0000000000000000000000000000000000000000..dab9680f844f967ccc05ce14581b12a3441b2f83 GIT binary patch literal 8364 zcmXw91yEGq+a?4Aq)S>lmXPj{4(Wy^1Xe&AR=QS7mTswCQj}5}mhSEnrMs5y^27gc zzWdDFInSMY;-34S^UV9qiPF|o#>1h)K|w*mQ&myWML|K;c`BPd$9%dEX4WO3pu9p+ zRd}QCgNn?-oit1+nd6 z--W+0e*yn;|1mMo%i)9h>M@vR+S>-=%H;eW|_gWcui^b=8g%I?dF$jz^ zFkgw1%akfss$MMfv<0NI{N~PEI?~h_jVcofXro15|Gu(meET>lqeQag;lsrx`3#?Q zwS8wQE5EYbJ@hN>G7I>8bfHv*=mUK*KMTTne$HmlYBH5Vfn+(z$pN$d-g&5PB4u>r zhJMhTgZ+k9#*|v!ad0i#daMGAYriT%>Boq~X(sq&S&2j|&}iOCV7)~Xv4lp^GZY#mDw|5NkhTeT$jh`!Q6X;OiykgIVtz;R6LtRd(7LfNnyxr9G~!1%J534^-*CsJm#{ zRsxx;yF{w=O=$#%n zCR}bx?L}Z^BQ>1N=&h&o45&xdpMch&edn)qddBd^*_NUiJc#v@&&jezaPRJRSOFj` zF!3U674F*Ke(aC8>~ASO5+!*`A1~f@hWRxxY~4i5ch^Peah3oMw`V`6Yj(9Ioz`Sj zqW9^JQV(4;bE83Da%}>umUM)^n-Tb^#t3l3HYl2=$}qmklZ;HWOjomGa*508R3nvv zIYV+~iySjUBUtrKg*c0z$2{JO@GX~V7TEO)7Na<1m)$*HwK8S;3`$gwXD(g6b-(*0 z$oQBKQG`S5VD2uVnq1)>Phq2H7*q-FDm+s|&>P=`>%Y^2ZtF=$MYq)-)nW}5T-9!C zEvWrYl?Ch%q*_XJ`CTqIG4PH<*0M$a9(?BcK7{3vvNZWaD6lQSQ?Jd_xg!5{Df7TD zNF26Z4*A7cP@pwBAY;N4DRYl^`sGd>e3og<8~2R0`C_CJ9MO6fs(@jtBtoj2FB;>l zPLNkF2hshYRHmHj;A&c#ez-cLJ6}#ayeo6lV85p7DpHUFHXoE-hTO4usSXwb+$*LG(Y@P?& zh`XqqdkOYJXAB@#pad3Fy2tK6x0n^GCl(rRdM!LvP-Hf=NnwzCU4L>Tmji!_q)-b=+0xx`BUiay-tDQ{B_x1Vm`Nl7yiF zW#T6AlQN5wVv68ze%!X;-}2bZ>*ho0Ent{cIBM8m`oc2W6m{euuf%tCjO}|Ad`Bbj zK6xYP1M~|~f?1R`%Vf{=>zj4@0Rvz0idJt9dqj}$cDhE(gG9z6R*vg$se(Bq3RMxe zcUk;NW@2}lgS4;140-TUL+iEQ-e=eBW*=lpaWl9Mt?h4YBv~eYByrwQIml|mXx;{e z$A~UsI;E7ST!CO?b0W@l>1FgMmIK{{2hTXJ?qcJ$xJV!%ZTNG&5Fbr-Bj>*TA0dFX z8v1+E48X2+ZoxtLC+PJl)KO=S@Mo{r#~n#H6&?GHb-f_KeJ zn?n48=6>UrS*jhRpuNwg#eRD(*-<#<>I!}O_v@2g|i&zxAd zN(MTpS?%f$@<6I<~ALz1%{XI*Jhz~%AOL0W@Ia0>j zi{;$KtV%LXcrlbSEynQ8!ml%ThW$nVfVsa2AIa05UQXz2^Vi#%^7(z)A-ptoK~Lp~$}Y0C1kp`@Q}-*HT*ilhEB5}5 zH%nz#;yUE(&t_CEgQ@bU-CiTXNq9OreE_$h@wiQ!zk5QgZxSd#Pt~^x!8#odkmSHy zK8B^gjm`V;7Z4lCoC6JDU7E9 zWT5}<)$jnW3&b$&_<5%mkiC0Uo2II@ASrimFf$lj<9)-#k_x0Q`g4Y>Rr&p z^e1&`W77v$zrZ3r_LW)}`v4{Fa9GX$ue9>YxiX7@>NAC z($5NtUC_kjy}T^=>eUH{>tD0@*U3eJpgjBw=5z1PnE-#w2d^0YYuNN>yyaS+h#^4+ zRLm?Tx}a{8Vnth}NsT7_WnZl+N2TRIs81vOZB=-c8f=(p(L@~|UrR=ANGXRr)STRV zF@S#05M+6;BzQtX4`qb~dF(2oTEwehmc6Oy@3WtcDh1c(8+OE+kpiSmg5!BkR3N^QyhJ1ZiBHl|^&3w^bEk$%Lt6071qC)=4+YF?WV72d@hbmrcxR&s@i7PF*eiVf(=L>#kVfAQw2MA5!rWfmPOc z#44M}&oN)udzv<}RXe0Mob}!$fRv%M?Wde6MvCWMI9w#nvGnxSV#(h3R6)axI!Bn@ z?*J#{ERnb|bXe2I1TTNZ6C*v<2Ly_sOMbxn$yjN=0*W$}f~x!JhhUabEmvg4&BghX zN}uijB-C*OLnwcZ$9@_Q4-aE>o|6>MV;W0!p|vvfxp!9&yL;tOT9q%Mv3l7qGuTUV zZ9Nis5=oKmLTq9!>ARf+U_O|YARftC*3O@ct`PD z@#MI0=oE^cOg)=PhjE_dM$YgsX-Uz>N}uRYUv2+TC3Bj(UUbuQ65~AAUV5B49O3z9 zWSCIN_X6Fz<*sG0kuTyH(~|a)rzvr>3+}dHMzUGRa}hR^W*3Y}Dmzm;o@DzBcic-k z!xxs$r2@6?oH7ihq*x%TCfURcYPdYGRa>8)0eDht4ii_AU3Z5KTzn5NIR>pB2Ix@j z^g8|}OBJP~b|fvL*ng?mt~|=C3Q3Y~pxNi!+*i+J8>r?0E1pS2r}dD15q8+bCAFZu{m>utLx^Tr=7BQaQ0V{!44B|3uVAV z@iz8?&n{tkd|~c>$EQ(pxHxa_7=M;@$8XA)itWkMGRgTl5wB9+cox}>q0_83;Ng~J z61uRMT~{7`o9Ba(EspfVC_YFWKU$HIT%E3m;0;fou4LP*^KYrOr|A_qK4QC~74Thf(QrY{B&(7ww-JUOzA@|N-pK@7_K3L{OotkI!(tAEzF%LL z9JU(h$SGZ6YSPmN1W>Sqmr_3^Ej}V$tH>nedigY0&And{|)_ zvbjzTqLv~0<1Ij^HPC1K&YU`wy7qX_+d3SD4AExH; zu94O3ViQA25lJTU-XT-D6yV!PO6H(HgEqzPZ0=*?(k2YfctDXv7+nw7!_KgeC|~M& zRlF}|bDW~4a;K=Nh5^rGyp2oA*f-rZFa#X8X#UEY8hif%N8Ej)}PO3tcD`=eM6b~h4bB?4j%DnW|TXB2gY|yUHz{=zK zdwpfC$O4LAic(}hc2rQht$TRgZcE;qb^|~C?bFE~7M?DoVb_79Q6>A^M9W}Cc>8HnIM67LJ3_G*yKikQ}c_tK{Gnb4bjTi@{G$O3wP+>Q!+_2+S* zrgkbxr`Y`B-hdRfoJS_DsnYV>Qu~*I+?QAV zqcH=~^z`(1;U4dsFflEZ=z|1>w+)uM;tSWSY6)H_*2gZ7dJZ5v_~H!cd^ajtF*Kyd zQ)>`kb1s-A?YGGQG&j>Ba*B;)sD2WvjyEP2QK!}0j;H3Y{WPzD@p`XpDqK6cE-rsn zmRBV2JGX8b<{K9rG!$<8=sNsMjT3LYzUCYs{BFcV=wKdD?BTMHOD+ClE>o=!z0;*2<|B1`Hw{+YX=H*W5A42DBF(G@p6w>Y)n zhCyx}pxyW#u8g5i2q0<+!fQEEBP@kIhabth2fvtdKzBVLz@@uZL@ABT37Ras_Ig^N zRbbt0u6iL@EnrBY(^gvyp^#JxFm}Ob!k6iwN(-mw~xfOe3xL!JHj68PY$xe(|Vc)cL9n@%}JJpo+ST4y=@$`_e73}wddS1DgCddXh7T2g2}2Uv_LRPFK& zQ%H~RVD~pEi$`O@gCkBmi2Q2ebvhdmm~rQKl2cUZ@hW~*yGTm^cDe9w3SNw z{LHx@z7102(81Z#Eo{Zf&58N0w^T=#85wLs_Es#=ZLd3CR((Y_M>OH$f%G(L4{Z|E zHTK3xD};yF(VLPPJ7EN3Q7b%utt)UJGS7h-^Uu9HS(9~O!O5#*>`B_o`KZzj?B-&- z@FA-iy*bwmZe$>^lbTYW#B|&P#>twkv>*0ECKr9P9Il%tmGqqNkM9|=pr_oWrEm76 zMf2#;u+Xp;X!>u1IF0gM_~q^Z50qB+^ZJY=him2#1A_R2;67Y zCV#3kj{0P_)u3~7B)t6BoF%?!vFJ?tf~?7Z?pup!!Y)ZUMI$7$9dfwdUgzv&@WA*M zCTZf*RVyz#uA_FoQxG3_*nBo>zliuau^K4?ulBe@)+?u*dzr*sRKFjAN?&&nC`How z*)!4PNv(#FP>tPU-m|Eu?Y#2T`rSwC4HUE+&EAQVIJEbpM?*xT^H64pdA$>>hubJ#!Mbzuq%3$=-PZi%W|)H#`;E4ytXKFpLTWp{LR zC`cZg%fgb#Yo6`6;M)#7KSJ$LPZ}t^+Mg|V>`(4bZH4)6W$Ef4%9RkIjISk zUIcqvoIs5fz=4x1AYOlyXRy}a*K_9HIoL_fKM;E*tl>_5*kg-bsEEVksbKm2K*Rk`jzGGkpX%LKjESdz2%?W{jS zOQ~%SC6H#Xj|I#EUb`+eD;YO9&|`^PTd8ujlW0j+PJHO9dWx5Rv3BMI1uLTpAV<80 z5n`v*=trD|&nm{5OT5(O>)8mU=53h&Fw-Y>b?M;80GrqqI=Aey{DO!(o^=$%Ja88> zf4-{Qe}iMhT4P_A*Q}1KQ@i1)^)BBgUaBsUb{Q?A+rl3S+Blxp({fIl$2=X)GIMPa z@;e=1qxJ|I=IiTjWulgm+}@BCs+gHAVnkQ_?LPL32;b|^4Qxy0iq^PF{ogYpUUU>{ z5to{YF3)r~S%QsMc8plMSO0!D%Z$(I=tr`fnQMnK)1Ow5#FPCWZPID+g-pvRzRtgE z2E^J^&!u);8Db-jN8{0J>lHwRk!g<+)Gn_zo{_VMoaGpr1gNPZv1Vn7;|_J5=c{@e zo_Ay9Vx=5_HMdJ|$gSq;|Rx@;7zus*LogY+>NvnQiXnu}$ z4|ewd2`)u`Si~-XB#fSh3HN ziQe8T2|Fz!gsf3yxt`w}s}^K?0eySb5^6FS8E-to$=wfeV~KfzP4Vc)(W>M&OOr`) z*VjKb$=vgN5eLUTZyhAN*E>jF}fkIXVspE3mP z;&vGse->wZs4+(Be7VKSZ+M}dCVI(YS;4+@HYzbz$R^0jN@wv5-e1_qzC4O~Yyq7FG$LeW{kBci(PZgDe8T z-_AUSxXW*nteTXMWcfIOJWR=H(`0(_dVXQ|-tN2QqLf!ECob=<6uOe>B{0;en@mMb zc}bpa*THYofBdFj>IhB03-a4Ezkbmx%K^#6F&>wbQ*mE}4czZyg% zHhyBZnnxNKHbTKmaHPm^w*hBc3~BOrM-j7DWqs}ZTaedxsYO)(Xws{hxLm{^{UZb& zg1$Hk`R%pclyj07@ITrC$yI17pp)nLCsn_@pV*)7>jdY2V&U!fihbhnTc0-cpZ*BD zKQUoGXV9x94n1zGOpEPy;6ZvnPw||{nQv&;dOEysm4TBWWEC#Z{WF0S*BtJ+FHNrIcbN(vD~53M zw*JqwU)K>!Orea9h{U;*2Ibj~Wclsq=$31PWRh9$DPX-?YSGQPys)wBe02t*aG67^vz^9nf=lDp`NX`89*A2E)y zzB<6>jPxDg*A%uy8Kk){A~>;DrkT%)qRmdi$C+|Bc0hA>Xi6y+1}w~eL3hZSPGPx= zVuRT;zoXyh=C!rs_pSTU&w3ZJhmHiQXLOJ>P8;RG3VZxp?$5twxlG!xE`_4k8suBv z3>r~w{E75+-;(?UUV&gyW%FYN@5(o84{osRZxLye*5HZbXPrfawmIQ{+!An{+lAJn z(fO=El&Ut?lK}I6L<(-eMaN$B>-p_T5#nWECXeqwgz~IB@$a|?twVMcryEoZ?I@n!iksI+;Y>@^rte5v$7)q+}v2fH|>fP=C~5LjCHaZryHA?(UKo8&;d52;Yt1__#EFFC=pfl)08WW1Je(sjhmSKxN%O6R zrNnGMrmEZ2i&|uVg_k;bFolD4XSWz$XG!^&$OSV6PC zY>7?ptdObf1(B@@5ddm7PyT#@aS)cK1hR(pydX||(3sSiOmtI>hxuvMwo7NJ$3=1I zitk?hVsjrPFd+o&4ptC|?#7D(`zB-oM8(?lZ#IO?pu6U!ajN^+^=scrB%Y`t@# zbvn$*R5qft3I)mf30S{lthQDi%@X-BF;hRLm(;PT?CgNU2F#<~aR?8S(x z-mNuJr##8O(97dTzUIaB@Znv|6I>_@Z7Up7^o}G55xjWwu4Y4cN3=T`9!mj}NJm#s z=h0w(EUO;nKYB@%M2C;sA3rSAGg)0Oqsb_@T0JJIr8pl5@(4Oucpc;OF0U&x+M_u^bb4A)EZ&2>bShuE4Sh!?mwsa z1^6A!h+~I4M_f8k{TL>Zb-2U%FMK1jqZFes262RUKad>F+rfn864otBOg8m81{96Psxt`$Rww&aZ!B06|~xf|z=5_eEkbr2m(5 uto=(SM33Z#|D){e6R)2A_bQ9%@!uLeqov&ssc)aUL{U}LRH%@%`t*MV@=@Uc literal 0 HcmV?d00001 diff --git a/docs/images/KfrvacR.png b/docs/images/KfrvacR.png new file mode 100644 index 0000000000000000000000000000000000000000..6cd429f054c2fcaddf3c579ca2b68da514073f78 GIT binary patch literal 7928 zcmb7J^ z)yBZk!O+1hr`a$+=NNy3;7Q8zA@8#Lo?ZGpCl?nN5hm%&r%y33(9!h*#q2b5dFXjw zz5F*qgr0eXhe`WSa;AL{4%-y)WMBMS+x{5i@+H|^`D>C)v(v3aDAVVex38L{?8}Z= z+VW$M4iHuQw}WeYLjzH5BrJFBZrdh%0g^Ai*_x^K9#m_V*M$2 zr5d1~41mkUlPp6*pB6|KU}fHX@mYAw>l>nhG-XkmeaNvSsO!R2KkU+_qB}v2t%}hu zgE!sP`w>@&*>Ypx=u*agTOpWwSV+L^=qxuDk6*;(X?nx`da?O*Wct9sa2iyKtZpmM ze8PP>dMj7&yz!i7v?M=0^oh@LC14n}EW%xWv|RlsBRh?ENj;l&*L1*G^edd^dQkFH z_!N~PCBWxB9ZKNG{O2eI$J0^U+0GC) zNu|Qab>|o0kZW-8!&Nqq+emVE3k-U#Gu+KEs@@rU;FTP|9#d0c;kmsgp%jA?_B9Lk ztkK8F;tB$kx`X!(iMY@)w8w zq+;E;x{DB&=$vj-*K(|q$e3*`%2IL!IkZE3y6pLx%XYh|u8#p0y zv33%RiO02IVdL&OKaN{6)rvE3j~5s93d!q2u@*1<#sEGP-_yA8<-U+{AI_O~Q~6L? zxjFt?MCA0T>Kw(Yy0B9y1MUiOmoNU^weK4!?C!43e5Mr((oY8T?9%md;o`e>wrX$M zt(zQ8#Pl%?M}FogZ!{h%uGd_={S6_N%r0r@bC<&J+V8PgE?JG<{L;1TY!DsbKY~zq zm9x503`OcOiT8fkwsoX(SUk^)9?zeI(8WAkwC{Xgg?s)% zLnXLxri6tX7tcXRLcWWu7O7D`fzp}BPZU(!GtQ2K-vL|wJz$kr@7{K9^KoahvJ@YY z1`47Cj@e5?;Z%3Hn+amdV5s;wvTf(~k()-7*U7RP_4G)-6R zMzC>l-3b7oiw)Xzi0@SEQoIo82`D%_G@N05r>|>#50(X1?R1?iR}p{;Tt=-*JZa}^ z*1fOh)s_nP`jff9P6NzFPd7cpB;h*E12!CN-LxOQ5CEW>;b@4s;uM9zXKb%V*q-j` z-m2|V>H#Ud5s7mPUzzh~8dEk%0rz?D=a<4D&&}#lC#B{|xh6YCBDHhJyl1G{1SOHR zizvhPGJH`SGM<2>h)n9~$@iuU9OW0PUOw+UWEIADEzPx!F5lPk7P3R&Z=~0 znhv15ext>cL;o32;cEHRqLOj`oA%xYH$PmXIL@MN^kvDm;g5+L&)7PgWwx-(Yw5<7 z0A#Dbc|VEJ+4cglrE2Efj4D7<+~?aJ{LS?qaJ&_Q^vmk45MO5Ybu@L zP>(O%I|n|VA{(L}sGH=B9E-!!8nDFeZC?iW_1>+yhWl*YX>_t@o#CUv{dES^U_D~$ z;yjFM97OdP8u@gFvHK%0zaef7c#=TMP?mv;Cm-ClV@wzwS*iUu&?E53JwzB5nbLsV z$AaU=DsPRfn>68{b@5`d!L9Vxkl2#cLF1i(mDi;|=<{0e@bbH8a$So(-tCaLC}%18 zi|S~SN`IL>TJ}h-=!XA$QQ9AM`jgTU{lWDE60;HROD9S<9hzqZDGuQ-Go5)@r>9(>;y>zt z5s$fT@3%D!@CM z?we`->4ddFv(hgxIT`-OEF}$x!p&Iv_|!Jjpaib%j0sG3Y10K3M+#50zBW2l)N?Yz#Vkq0sCHCI8@--!=XLx{<&LZDNUZ?P`o*Z=qNN`8$0K3A-y_-YI_ z-*a=&3o5EWw|TwZ>7tfUqE>mB2D&!|;$PH~Jc4fyJQv;b8<(fp1qr%*ylOq?mGrkO zj+~hjwcepApz5xX6#zu)iF)zZ0EyCMI4x*yn?flxM*rsw=zLR-s_l`6F+92)7j4J_ zIx;q+pmK=m8+KV5o2ck+*=WehL`c#By;sFe3s)CTIoTigKVZlx3x%y<6dtS+F8PLV194fz$Mez? zm1O$9W(Q6DZ*Z#B-~jG&WId-k%$mvu9T{Me(#x>)Xv2{^r`3k2(24V$!zV-q>@hD& zOaUi58zz@dO9Ad10VNpc{@tEh(-+w?lZ?+5)7qU(gc%%8D>`k?#6R_d;iYBfHpBwM z(LdQLbpJ!2B#tqF_oN%?Ucvh8qzTM6kllSwK%ZzM zilu%Ik#Cxtxo6MR-(sEl1-gqbqb)G~x#zIZVGx8%ZpXV=k}xeTyxKL{IBU&qv=b+% z2#9RlYZ&$Y^Tjq!-NNFR?jLPG?4^G|APq~DAV;@&O(H5}?z^qBMrB0Jv%WTig1ZBJ zL@=!c^xvGuY43}#F7Hs9M|(P9w|qAg#FlESD5?3;)K3C#BECfX6m!=Erb!~2;PCmE z2U)W1mc)_q3hf!wD~J4BV!+Zya)G_C?Zzs)qB}!EUv1Q;zq=oe3mS_HxyAA9t-har zm4%CM9)!wl%DAyxkNU?_*f`8DY;a-G@Qi`I+xAr>cT2%tCh3n^-9zh+>hlw@9WuC=f@J-g`%F%-3Rl1PD-A}B>xf7`^q)5)*jOKvN-Pog>62Cp#FIhG z#_80;|EPsN`Q!6jnr79$L2;LZY@UrQ4V8qBfnCVqI7>P-@XGQnRkeDi3?9 zD}e5MPHuH2q&3zE6+#nSy8ZE!(nv7S_F-w6u~a|crLpaHdun3ldv>ES0y!SG9G zkCO*Q?dFhq%KEo~`Y)(fzqPU_2xY>tq*G7w`#fq{SJmP#mKZd!U!XXwX(wfDpmR)ws~BU0 zf91l^=Q~E}Hu-i95#s;`kD0#0p{2QtU5t|RX2Oj^&2PJu7-drf)C^PET2a<(hQZL` zM}%3KP#+THDI-BD-ne<)KUZotnSo2v+YP*y=n&maHgSt+x-aQ4rYqaq7VMK|)AuyJ z99ys7^HiRj;I`Zd6hO)?Burgs(s92JE|K;PNzrh3vFCFw?0KXofS2(3e>;Vp$CKO| zo>BxJ`Rzzk`=_Ae@yajQ5cbT4n*M;kU%2h&vMByZNnakDT6tdhWr|;$lh`*EjPE@k z+oUO*9uHkG?=CR^XG;3Ddjbis&5Mx5D$AJKU$yD{tKGSc_GGF1QZZcTQ3z@p!`9>T zFOE?v0Q8UIj6*YJ?e#XA@)_k&k<@4xF++SQum8YM>g`ZS<#|Gj0t2eEYr8>~$$E~? z*xWY=xl7I|uyR9-2_ju zzi4d50y#|6M_>G&n#51O-GIKFdCB^(s;c6AsH*HX7qIKG9_p{Z3j(@YUfI)Xi@kc7 zH#fuJ(7fJSmEKPs;aY5<4fnWeU~Tf4>u<#4Lj;@tTBrD8@IYOJda(bMWW-{xxbBF1 z0=|j=)BYXq>r#+!$KcoKEB4<&sMtng3)E#ScYh?}H1Zy;voDXn`1+D! zhn;*fN@t?@EY&uKYLq?uFJ*pICzY#v5q6&$GuGN=5pl|Seki6 zUZ$XkMmUG~B#vU+EIFh|L>DOR8Z)>THx6qH{Hb)8<8t<$W__aSBC8)XW?s!TR0 z0>(3e;^q*_5*{!=eRB`9YKgU{;FR6>72ByIh=g^U;uS6q&UYgF!7RO6TRlC?e8rT! zixOx{^AMDJz~1C5btnldLB*VUTX2xS^wxNZ)l`wnsXPKCn**(L%+112BLQiBOFwJD zrQn%ZaavZuGL2!BEoB~N5bnTV2*_~fzB~r;iKWE()VQ?{Q$3o#A*|2wEDIzpC~XT8 zT5k6G45B4q^B`i@e3wVHr()4h12paoA>QficQG&!qv|a4y8dI{>WA3}g}d0c+o|g}FzKO7QuY7Cz0}^i?RoZn@k@$u8EZmEP*N8_kjm@f=L%<`!+sS4z|F zhTD(H%@jc@Kh8*z>Jb_C3f=r}-??nQJ_v;vOhbK|o=XfxgQ+3im3u*-51VSc9QWs{ zr_$qJ=H!CSe<-E!D5B^Rd)4z%>C`VdI)$&cvK=W(6vcjW-yeUqt!f@heAf<1wW@P8 zona1uwaj!_TE(&3eL^uH%6px5r;7W4p&GSl&Y^lm;Bq2`JJTOSVCQz_)BrO`o9wYd zKW1|qp*x+t2T?uc+lp=a`gr%rBg7I(eaaBGaE!FDFeCddWQ@JS#oD>vewhrtnP0mRdwV9S?NBN|tW185R+u8qmm2fMu4dQ#u+WLZI#|HQ;q)SW347`E z?Lplpb*Js!&1IokOlO12;?}JUwaCRU|LXM7Q1<3T27!PCU$N+$dDmsHU3&RT*~0lA z8D!}gMczQt37(5zn*qiU3mjOly{am#Pztmy&9eMphNc&rZ0fM_M2QR5 z7bnRqyB+HS_(${I)hiGr1+W{O-plu`Vl409NBISY4#(offwTP_rb=-1*|2NYnk@bpqW=0HM;?qxT5? zpWC>jXsTtM1c*yttu+E+69&wR2MxDQh`oVJT=9{sY~=T+hxkVLlZ|YZNGtXo8$D#_v0NisM8%od`5{)`$d=@M4=c2+}rLrZoDT>RrxZA;NO8R_E|3O%kUM zcPOu3h6Krt-!W|L#k$+hi_TEF)lwZZqoZB#a5TAg$4PZf{&Jb@#R^y`As)pjDu~AR zM8mru!HR@PehlGAE&31x_d3}aoO(hG)GYFW8zk?O)rd-}!A+pFJUnDZ$M9Z7c5&? zxHFa~^>OLh?lh9mqn*q+vE4r%PGp@GUnj{O1bC;K^f8xX^joa$rEL2Eed>0f3?4f* zYS83c&w2>kRsbQDB2}A{14dT_6>=wRBBe3aBn-MjTwF>3Z80JX!B^F|9lvxv_JUFP zlv_T^pd}`^+DL+neY$qYkm_es0bwjG)HzMYw;)TKwHL>~_Y{%~nP0%D-i6C)WSZ@z zu-VNjvCm{F&vG39{`~6;77_pIzJXHxdcLyTuGY?t-nc~ij;LGD2*G7*l>gr+;$3pf zCSVZQacuXhe)&cl8mrn`$WEG{z_ceRh4_n`GHDBUgqS~BgJa&yDe8c$m-k}Q%Xk0 za#h{M%3+aRxg7h*fO<}$5;~diTAD@0QE7uF8Av~Rm=hGqrhfk{&R}Tr}UIG8>0t=wWQ~%j^{w;C! zm#+AVAzwZX_d!PCIX?a;V&gxE*sXY3|B3(4**EJ3wIn-GnW`czCda8{`^>>CV2%t0 zm_YZ~U`u?yD+*)sF}h8lm?rm~=U4GhnR09nZ-~t9?WMyGV$5y8Bu+z7shsRWd|VNF zL6kVAX-g17*>?(lUB6+whRxc9qWQAMM>V{h71c)z2GQa_ncVPMeDP z@M$-hsd}UHrG5?HMWtE_)uL&7$c_Ci;1P3ZoTk$EYI6QcvtbSVH9kB3>kz(`bMEeC zZ{y28VClzYv?%+CdqiY?go`t!e;Ek<3UKR4+o zHGZQ_b^fHDw2i1_U9%>;wZ^;EAG-XNEY;6XS0Bp>cJ{s!M%DKVI7#Lgk2QIFhophqpel*=E#cea6rvNy%pXenV5o zX3BypLSf0nGcy{viGh;TJmM|QG6t09RA$rLGU+uK4fq_bbaL+!B4dl!Jnamw|Lj+v z7<83-l=<*1|Lvzi2+n|0q^xG3S&{HqxP+ba z6N$38%AgL*wiV^9$?|H$7*dJT(bcCBj(48KWmcqAe1e6LO*)&os)8r}v+@WueiGeu z8_hldOi8rsx|b=V=(S6+W*mi^3SwQ$T>8l=?Vvzc+Mf|wI}RP~)A7gSpcgBqqdSN| zTZUi;+Wcob9tOCfn0_#SLXkX|>~7?o@OHfOjPq;78+%BVmS&rLQB5Nm9TRJWV)rjn zuvlN#8kS}+_&b9xJCdhgf72S9shLe;$B$YWkN2!>o%@Vjpe@FE^0L1vJRxU14(K3o zGCUIVOt{@Lb7U$69sRGq#kBeAbxmn}eBjV!k@S=9wmy!K$AE)Sq@GFndw z`GPA-s(tG`S-b2#Z$kX}00YN3xbRz0+&I6}2A85>dD&q7tL0rWtkKuYfuD9J3b;i|79}nlSI3n_^+Nk`31byNoa9}R*M$v2 z?aUTc$44o=%bw%Ry|QEk?vsV;E_|k5mxHnf3HYOLMDH$EStfA?xsjkgCK2-Ile>`$ zII+VD8;tzT_1yuigzd*LUJ;sthQ_n!!U#6K!pg0X>k`O5=L03!#8J$Kg}p7M;I&N+ zF#=9(>||Fod!=fEHLrw7Q~||dkMg}}Ak)ma65H`lg*9@Q8eZPpD@y-bjTF@oHYm$h zI5q|e?GxtpF6>B{>smyWZ$Tb)$D1_|b#bDOpGk)SlL#Lu7oHK)E~j;xfzo9{s`B&q*VhqmvxCgQ7;YA0*gvl}PYR^M(m*Pn zjkP11$q;nrAu?4d8~g{Grk4|%qJ^_i<~X@NFL=71PkQA(?$Lxxn# z7sj+7%Ivk0JicW8;&7iBAJ2a7K*AcUp!#8BD2<}u^*P~-W-U5rtIoo2M>!3aP9wXb z6pF}O8NrAy-?PgtU_=57io*gSjeRG;Xd1}wmr0$!!}r`&y~W6|Kc}$(cqU01UaL>? zU6}*R7$8_L<+Giez(S&$aY_w8eKHQmi0-9(=1^1jtO>LwAV*opLHDX_FpQkDqv519 z?T7cILToc!bBZ8kHv(o;**ry~y){79vcV<>;RQ7g?)qV37g^;i3b>Q#4LDa_L6$3h zOBmr-OIWcaIEo&^Y3}bZLaX=!FcZRkCvcCuHt2^3?47V`A>dQ01#zp5;NN+mZP@!i z&$dq4+*vK6Jxuha;J?St*S8$b9Ie}P)NT^rY(EEYj6F@k^g}ndy_3tH#12Da3hZ4A z7oup=9~s~iBGgxBqOekEDtKFADDSMCO$?~pc*x_j4kO`Zzbf#fD$IEf2-L!8b$)P- znLS4&M}PDYX)+MUkuw{mV6SS?_6S9Pco z!)fljgAt6rfBk`xx~I-J0d||FdNPoI?SeNEV&*rY#-v71{6h!tMQ$GYB-Um!oweJG+8Mn$r5n`zyAY{*sRe2 literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md index 80cac75fa..cbaaf898d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,13 @@ -# Welcome to the PhoneInfoga documentation +--- +hide: +- navigation +--- + +# Welcome to the PhoneInfoga documentation website PhoneInfoga is one of the most advanced tools to scan international phone numbers. It allows you to first gather standard information such as country, area, carrier and line type on any international phone number, then search for footprints on search engines to try to find the VoIP provider or identify the owner. -### [Read the related blog post](https://medium.com/@SundownDEV/phone-number-scanning-osint-recon-tool-6ad8f0cac27b) +[Read the related blog post](https://medium.com/@SundownDEV/phone-number-scanning-osint-recon-tool-6ad8f0cac27b){ .md-button .md-button--primary } ## Features @@ -19,11 +24,3 @@ PhoneInfoga is one of the most advanced tools to scan international phone number - Does not allow to "track" a phone or its owner in real time - Does not allow to get the precise phone location - Does not allow to hack a phone ----- - -!!! bug - Found a bug ? Feel free to [open an issue](https://github.com/sundowndev/phoneinfoga/issues). - - You can also [reach me on Twitter](https://twitter.com/sundowndev) or at raphael(at)crvx.fr. - - PGP: [B64687AB97F268F43E67B97A8916203E540C65A4](https://crvx.fr/publickey.asc) diff --git a/mkdocs.yml b/mkdocs.yml index 99092fae5..6e01fa187 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,13 +5,14 @@ site_description: 'Advanced information gathering & OSINT tool for phone numbers site_author: 'Sundowndev' copyright: 'PhoneInfoga was developed by sundowndev and is licensed under GPL-3.0.' nav: - - 'Introduction': index.md - - 'Installation': install.md - - 'Usage': usage.md - - 'Scanners': scanners.md - - 'Formatting phone numbers': formatting.md - - 'Go module usage': go-module-usage.md - - 'Resources': resources.md + - 'Home': index.md + - 'Getting Started': + - 'Installation': getting-started/install.md + - 'Usage': getting-started/usage.md + - 'Formatting phone numbers': getting-started/formatting.md + - 'Scanners': getting-started/scanners.md + - 'Go module usage': getting-started/go-module-usage.md + - 'Additional resources': getting-started/resources.md - 'Contribute': contribute.md theme: name: material @@ -32,6 +33,9 @@ theme: name: Switch to light mode features: - content.tabs.link + - navigation.instant + - navigation.sections + - navigation.tabs extra: social: - icon: fontawesome/brands/github-alt @@ -45,6 +49,9 @@ markdown_extensions: - pymdownx.superfences - pymdownx.tabbed: alternate_style: true + - attr_list + - admonition + - pymdownx.details plugins: - search - minify: