Skip to content

Commit

Permalink
update readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
Yohann0617 committed Jan 8, 2025
1 parent 8479ce3 commit 2294924
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ COPY . .

# 执行Maven构建并将构建的jar文件复制到指定目录
RUN mvn clean package -DskipTests \
&& cp target/oci-helper-1.0.2.jar /app/oci-helper.jar
&& cp target/oci-helper-1.0.4.jar /app/oci-helper.jar

# 支持AMD、ARM两种架构的镜像
FROM openjdk:8-jre
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@

## 一键 docker-compose 部署或更新

安装完成后浏览器直接`ip:8818`即可访问(建议之后通过https访问),账号密码默认都是:`yohann`,如需修改请更改`/app/oci-helper/application.yml`中的配置并执行`docker restart oci-helper`重启docker容器即可。`密钥文件.pem`建议使用英文命名,并全部上传到`/app/oci-helper/keys`目录下,新增oci配置时只需输入`密钥文件名称.pem`即可,默认会加上这个目录全路径。
- 安装完成后浏览器直接`ip:8818`即可访问(建议之后通过https访问),账号密码默认都是:`yohann`
如需修改请更改`/app/oci-helper/application.yml`中的配置并执行`docker restart oci-helper`重启docker容器即可。
- `密钥文件.pem`建议使用英文命名,并全部上传到`/app/oci-helper/keys`目录下,新增oci配置时只需输入`密钥文件名称.pem`即可,默认会加上这个目录全路径。
- 如需查看完整日志,执行:`docker logs oci-helper >> /app/oci-helper/oci-helper.log`导出日志文件自行查看。

```bash
bash <(wget -qO- https://github.com/Yohann0617/oci-helper/releases/latest/download/sh_oci-helper_install.sh)
Expand Down Expand Up @@ -55,7 +58,7 @@ mkdir -p /app/oci-helper/keys && cd /app/oci-helper
### 2. 下载文件

1. 下载`Releases`中最新的`application.yml``oci-helper.db`这两个文件到`/app/oci-helper`目录下,并修改`application.yml`部分配置。
2. 如不使用 docker 部署则再下载一个`ocihelper-1.0.2.jar`文件到`/app/oci-helper`目录下,直接`nohup java -jar ocihelper-1.0.2.jar > /var/log/oci-helper.log &`运行即可(前提是环境上要有`jre8``jdk8`以上的环境)。
2. 如不使用 docker 部署则再下载一个`ocihelper-1.0.4.jar`文件到`/app/oci-helper`目录下,直接`nohup java -jar ocihelper-1.0.4.jar > /var/log/oci-helper.log &`运行即可(前提是环境上要有`jre8``jdk8`以上的环境)。
3. 后续如果更新jar包或者docker镜像,需要安装sqlite并运行`sh_oci-helper_install.sh`中更新版本号的命令(自行解决)。

### 3. docker部署
Expand Down
7 changes: 5 additions & 2 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@

## One-click docker-compose deployment or update

After the installation is complete, you can directly access it through `ip:8818` in the browser (it is recommended to access it through https later). The default account and password are: `yohann`. If you need to modify it, please change the configuration in `/app/oci-helper/application.yml` and execute `docker restart oci-helper` to restart the docker container. It is recommended to use English names for `keyfile.pem` and upload them all to the `/app/oci-helper/keys` directory. When adding oci configuration, you only need to enter `keyfileName.pem`, and the full path of this directory will be added by default.
- After the installation is complete, you can directly access it through `ip:8818` in the browser (it is recommended to access it through https later). The default account and password are both: `yohann`.
If you need to modify it, please change the configuration in `/app/oci-helper/application.yml` and execute `docker restart oci-helper` to restart the docker container.
- It is recommended to use English names for `key files.pem` and upload them all to the `/app/oci-helper/keys` directory. When adding oci configuration, just enter `key file name.pem`. The full path of this directory will be added by default.
- If you need to view the complete log, execute: `docker logs oci-helper >> /app/oci-helper/oci-helper.log` to export the log file and view it yourself.

```bash
bash <(wget -qO- https://github.com/Yohann0617/oci-helper/releases/latest/download/sh_oci-helper_install.sh)
Expand Down Expand Up @@ -56,7 +59,7 @@ mkdir -p /app/oci-helper/keys && cd /app/oci-helper
### 2. Download files

1. Download the latest `application.yml` and `oci-helper.db` files in `Releases` to the `/app/oci-helper` directory, and modify some configurations of `application.yml`.
2. If you do not use docker deployment, download another `ocihelper-1.0.2.jar` file to the `/app/oci-helper` directory, and run it directly `nohup java -jar ocihelper-1.0.2.jar > /var/log/oci-helper.log &` (the prerequisite is that the environment must have `jre8` or `jdk8` or above).
2. If you do not use docker deployment, download another `ocihelper-1.0.4.jar` file to the `/app/oci-helper` directory, and run it directly `nohup java -jar ocihelper-1.0.4.jar > /var/log/oci-helper.log &` (the prerequisite is that the environment must have `jre8` or `jdk8` or above).
3. If you update the jar package or docker image later, you need to install sqlite and run the command to update the version number in `sh_oci-helper_install.sh` (solve it yourself).

### 3. Docker deployment
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.yohann</groupId>
<artifactId>oci-helper</artifactId>
<version>1.0.2</version>
<version>1.0.4</version>
<name>oci-helper</name>
<description>oci helper</description>
<properties>
Expand Down

0 comments on commit 2294924

Please sign in to comment.