Merge branch 'little_stone-main-patch-55824' into 'main'HEADmain

Update README.md

See merge request little_stone/webcomponent!2

1 files changed, 45 insertions, 74 deletions

diff --git a/README.md b/README.md
index 945ce35..a4954ef 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,63 @@
 # webComponent
 
+检测网站使用的组件
 
+## 目录&文件说明
 
-## Getting started
+- wappalyzer文件夹：包含指纹源文件，没事儿别乱动
+- technologies.json：整理过后能做匹配的指纹文件，没事儿别乱动（截至今日，是最新的）
+- webComponent.py：用于整理指纹的文件，没事儿别乱动
+- componentServer：linux可执行文件，用法看后面
+- componentClient：用法看后面
+- componentDetect.py：检测程序，可以随便改
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+该工具有两种使用方式，具体如下
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## 第一种使用方式（推荐）
 
-## Add your files
+将该工具部署在服务器上，这样任何人都可以向服务端发请求使用
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+服务器环境：
+1. python3环境，不需要安装任何依赖
+2. 必须确保能正常访问github，因为要访问github自动更新指纹库
 
-```
-cd existing_repo
-git remote add origin https://git.mesalab.cn/little_stone/webcomponent.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://git.mesalab.cn/little_stone/webcomponent/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
+部署步骤如下：
+1. 首先将该项目上传至服务器
+2. 进入目录文件夹执行命令chmod 777 componentServer
+3. 开启服务端，执行./componentServer
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+客户端请求方法：
+1. 将componentClient.py下载到你电脑上，运行即可，里面代码看下面实例
+```
+import requests
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+domainlist = ["csdn.net", "youku.com", "wappalyzer.com"]
+for domain in domainlist:
+    # 这边填你的内网服务器地址，端口8000，参数只传域名，别加协议
+    req = requests.get("http://192.168.231.129:8000", params={"domain": domain})
+    print(req.text, type(req.text))
+```
+返回值如下（返回一个字典，key是组件名，value是组件类别）：
+```
+{"Element UI":"JavaScript frameworks","OpenResty":"Web servers","Vue.js":"JavaScript frameworks","jQuery":"JavaScript libraries"}
+ <class 'str'>
+{"Ant Design":"UI frameworks","React":"JavaScript frameworks","Tengine":"Web servers"}
+ <class 'str'>
+{"Amazon S3":"Miscellaneous","Google Tag Manager":"Tag managers","Nuxt.js":"JavaScript frameworks","Vue.js":"JavaScript frameworks"}
+ <class 'str'>
+```
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+## 第二种使用方式（不推荐）
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+直接将项目中的componentDetect.py和technologies.json下载到本地，用法写在componentDetect.py里了
+本地环境：
+- python3，记得安装componentDetect的依赖，一共没几个，自己看看手动按一下即可
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## 自动更新
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+如果按照第一种方式部署在服务器上，则服务端运行开始会进行自动更新，记得确保服务器能正常访问github
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+wappalyzer的指纹库更新频率不大，遂设置两个月更新一次
 
-## License
-For open source projects, say how it is licensed.
+第二种方式的指纹不会自动更新，所以，你要去你的服务器上下载最新的指纹库，直接下载technologies.json就行
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.