更新readme

This commit is contained in:
bob
2025-03-10 17:32:08 +08:00
parent 7fbc9954dc
commit a0992c14fc
16 changed files with 8 additions and 137 deletions

145
README.md
View File

@@ -114,138 +114,6 @@ Open AnyLink是一款面向企业的IM即时通讯解决方案旨在帮助企
![img_4.png](doc/image/img_4.png)
![img_5.png](doc/image/img_5.png)
![img_6.png](doc/image/img_6.png)
## 项目本地安装及运行Windows
### Web端
```shell
# 克隆项目: github
git clone https://github.com/GatlinHa/open-anylink-web.git
# 克隆项目: gitee
git clone https://gitee.com/lijingbo-2021/open-anylink-web.git
# 进入项目根目录,执行安装依赖
pnpm install
# 开发环境本地运行
pnpm dev
# 编译生产环境版本
pnpm build:prod
```
### 服务端
#### 拷贝项目
```shell
# 克隆项目: github
git clone https://github.com/GatlinHa/open-anylink.git
# 克隆项目: gitee
git clone https://gitee.com/lijingbo-2021/open-anylink.git
```
#### 安装Minio
- 安装过程详见官网指导https://min.io/download?view=aistor
- 启动Minio在安装目录根目录下创建一个bat文件然后执行启动
```shell
set MINIO_ACCESS_KEY=admin # 用户名
set MINIO_SECRET_KEY=12345678 # 密码
.\exe\minio.exe server .\data --address ":9001" --console-address ":9002"
```
- 登录miniohttp://127.0.0.1:9002/buckets 账号admin密码12345678
- 创建一个bucketName填anylink。如果起别的名字要修改nacos配置
![img_10.png](doc/image/img_10.png)
- 修改bucket的读取权限
![img_11.png](doc/image/img_11.png)
#### 安装MySQL
- 安装MySQL Server社区版8.x: https://dev.mysql.com/downloads/, 详细安装过程请查看官方文档。
- 注意nacos的jdbc配置为localhost:3306用户名密码是root/123456。如果安装不一致请修改nacos配置。
- 创建一个叫`anylink`的db
```sql
CREATE DATABASE anylink
CHARACTER SET utf8mb4
COLLATE utf8mb4_0900_ai_ci;
```
- 创建表分别执行sql文件中的建表语句
- [anylink-groupmng/src/main/resources/db/mysql.sql](anylink-groupmng/src/main/resources/db/mysql.sql)
- [anylink-chat/src/main/resources/db/mysql.sql](anylink-chat/src/main/resources/db/mysql.sql)
- [anylink-mts/src/main/resources/db/mysql.sql](anylink-mts/src/main/resources/db/mysql.sql)
- [anylink-user/src/main/resources/db/mysql.sql](anylink-user/src/main/resources/db/mysql.sql)
#### 安装Redis
- 下载安装包https://github.com/tporadowski/redis/releases, 安装过程详见官网文档。
- 注意请使用默认端口无密码如不一致请同步修改nacos配置。
#### 安装Kafka MQ
- 下载安装包https://kafka.apache.org/downloads, 安装过程详见官网文档。
- 安装后进入到目录:`kafka\bin\windows` 下先启动zookeeper服务再启动kafka服务
```shell
#要先启动zookeeper服务
./zookeeper-server-start.bat ../../config/zookeeper.properties
# 再启动kafka服务
./kafka-server-start.bat ../../config/server.properties
```
#### 安装MongoDB
- 安装过程详见官方文档https://www.mongodb.com/zh-cn/docs/manual/administration/install-community/
- 注意请使用默认端口无密码。如不一致请同步修改nacos配置。
#### 安装Nacos
- 安装过程详见官网指导https://nacos.io/docs/next/quickstart/quick-start/
- 本地以standalone单机模式启动
```shell
startup.cmd -m standalone
```
- 创建命名空间
```shell
curl -d 'namespaceId=dev20250303001' -d 'namespaceName=dev' -d 'namespaceDesc=Development Environment' -X POST 'http://127.0.0.1:8848/nacos/v2/console/namespace'
```
- 浏览器登录nacos http://127.0.0.1:8848/nacos
- 导入配置,配置文件在:[doc/config/nacos/nacos_config_export_20250303203503.zip](doc/config/nacos/nacos_config_export_20250303203503.zip)
![img_7.png](doc/image/img_7.png)
- 修改个别配置项修改这三个配置文件中关于本地IP的配置改成自己的192.168网段的本地IP修改完后记得点击`发布`。
![img_8.png](doc/image/img_8.png)
![img_9.png](doc/image/img_9.png)
#### 启动服务端项目
- 编译打包
```shell
mvn clean package
```
- 分别在单独命令窗口依次启动6个微服务注意替换jar包的版本号
```shell
java -jar ./anylink-agw/target/anylink-agw-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848
```
```shell
java -jar ./anylink-chat/target/anylink-chat-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --dubbo.registry.parameters.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848 --dubbo.registry.address=nacos://localhost:8848
```
```shell
java -jar ./anylink-groupmng/target/anylink-groupmng-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --dubbo.registry.parameters.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848 --dubbo.registry.address=nacos://localhost:8848
```
```shell
java -jar ./anylink-mts/target/anylink-mts-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848
```
```shell
java -jar ./anylink-netty/target/anylink-netty-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --dubbo.registry.parameters.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848 --dubbo.registry.address=nacos://localhost:8848
```
```shell
java -jar ./anylink-user/target/anylink-user-1.0.0.jar --spring.profiles.active=dev --spring.cloud.nacos.config.namespace=dev20250303001 --spring.cloud.nacos.discovery.namespace=dev20250303001 --dubbo.registry.parameters.namespace=dev20250303001 --spring.cloud.nacos.config.server-addr=localhost:8848 --spring.cloud.nacos.discovery.server-addr=localhost:8848 --dubbo.registry.address=nacos://localhost:8848
```
## 开源项目免责声明
1. **项目性质与保证范围**:本 开源项目由本作者开发并在 GitHub 上开源发布旨在为用户提供面向企业的IM即时通讯解决方案。在法律允许的最大限度内开发者不对软件的功能性、安全性、适用性作出任何形式的明示或暗示保证包括但不限于软件无错误、能持续正常运行或完全适配用户特定环境等。
@@ -258,21 +126,24 @@ git clone https://gitee.com/lijingbo-2021/open-anylink.git
## 交流社群
<img src="doc/image/wx_group.png" alt="交流社群" width="30%" />
<img src="doc/image/qq_group.jpg" alt="QQ交流社群" width="30%" />
<img src="doc/image/wx_group.png" alt="微信交流社群" width="30%" />
QQ群号825505574微信群有效期3月17日
## 如何联系我们
- **QQ**312777916
- **邮箱**312777916@qq.com
- **微信**wx_open_anylink_2025
- **微信**wx_open_anylink_2025(扫下方二维码)
<img src="doc/image/wx_code.jpg" alt="微信二维码" width="30%" />
### 最后,如果您觉得还不错,请 `Star`, `Fork`一下本项目或者“请”作者喝一杯coffee您的一次小小鼓励将会使我们前进很远很远。
<div style="display: flex;">
<img src="doc/image/zfb_sponsorship_code.jpg" alt="微信赞赏码" width="25%"/>
<img src="doc/image/wx_sponsorship_code.jpg" alt="微信赞赏码" width="35%"/>
<div style="display: flex; gap: 5px;">
<img src="doc/image/wx_sponsorship_code.png" alt="微信赞赏码" width="35%"/>
<img src="doc/image/zfb_sponsorship_code.png" alt="支付宝赞赏码" width="30%"/>
</div>
<br>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 436 KiB

After

Width:  |  Height:  |  Size: 579 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/image/qq_group.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 428 KiB

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB