This commit is contained in:
Darren 2023-07-21 16:14:35 +08:00 committed by GitHub
parent 2eb054ac3e
commit 292c2d4594
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 67 additions and 67 deletions

View file

@ -1,22 +1,22 @@
## 0.7.3 release on 2023-07-06
appmanage ci 更新
1. appmanage ci 更新
## 0.7.2 release on 2023-06-25
appmanage 自动更新接口升级
1. appmanage 自动更新接口升级
## 0.7.1 release on 2023-06-21
appmanage version 文件意外删除时 bug 修改
自动更新的时间频率调整为一天
更新脚本 version 文件不存在的 bug 修改
1. appmanage version 文件意外删除时 bug 修改
2. 自动更新的时间频率调整为一天
3. 更新脚本 version 文件不存在的 bug 修改
## 0.7.0 release on 2023-06-20
appstore 增加 更新功能
myapps 功能优化
新增 settings(设置) 功能
1. appstore 增加 更新功能
2. myapps 功能优化
3. 新增 settings(设置) 功能
## 0.6.0 release on 2023-06-17

View file

@ -1,3 +1,41 @@
# Contributing to Websoft9
This page provides information about contributing code to the Websoft9 core codebase.
From opening a bug report to creating a pull request: every contribution is appreciated and welcome.
If you're planning to implement a new feature or change the api please [create an issue](https://github.com/websoft9/websoft9/issues/new/choose) first. This way we can ensure that your precious work is not in vain.
## Not Sure Architecture?
It's important to figure out the design [architecture of Websoft9](docs/architecture.md)
## Fork
Contributor only allow to fork [main branch](https://github.com/Websoft9/websoft9/tree/main) and pull request for it. Maintainers don't accept any pr to **production branch**
## Pull request
## DevOps principle
We follow the development principle of minimization, rapid release
### Version
Use *[[major].[minor].[patch]](https://semver.org/lang/zh-CN/)* for version serial number and [version.json](../version.json) for version dependencies
### Artifact
Websoft9 use below [Artifact](https://jfrog.com/devops-tools/article/what-is-a-software-artifact/) for different usage:
* **Dockerhub for image**: Access [Websoft9 docker images](https://hub.docker.com/u/websoft9dev) on Dockerhub
* **Azure Storage for files**: Access [packages list](https://w9artifact.blob.core.windows.net/release?restype=container&comp=list) at [Azure Storage](https://learn.microsoft.com/en-us/azure/storage/storage-dotnet-how-to-use-blobs#list-the-blobs-in-a-container)
### Tags
- Type tags: Bug, enhancement, Documetation
- Stages Tags: PRD, Dev, QA(include deployment), Documentation
### WorkFlow
Websoft9 use the [gitlab workflow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) for development collaboration

15
SECURITY.md Normal file
View file

@ -0,0 +1,15 @@
# Security Policy
## Versions
As an open source product, we will only patch the latest major version for security vulnerabilities. Previous versions of Websoft9 will not be retroactively patched.
## Disclosing
You can get in touch with us regarding a vulnerability via [issue](https://github.com/Websoft9/websoft9/issues) or email at help@websoft9.com.
You can also disclose via huntr.dev. If you believe you have found a vulnerability, please disclose it on huntr and let us know.
https://huntr.dev/bounties/disclose
This will enable us to review the vulnerability and potentially reward you for your work.

View file

@ -4,5 +4,4 @@ AppManage is the core of Websoft9 which can manage application: Create, Stop, Un
* [API-design](docs/API-design.md)
* [Architecture](docs/architecture.md)
* [Developer](docs/developer.md)
* [Dev-Setup](docs/DEV-SETUP.md)

View file

@ -1,4 +1,4 @@
# Developer
# Dev-Setup
## Deployment

View file

@ -51,6 +51,8 @@ cancel_jobs = cancel.get_job_ids()
## Logs partition
Appmanage 日志采用 logging 生成,按自然日分割日志文件。日志路径:/var/lib/docker/volumes/w9appmanage_logs/\_data
```
logPath = 'logs/'
if not os.path.exists(logPath):

View file

@ -1,16 +0,0 @@
# Administrator 管理手册
## 数据同步
1. 将 APP 的版本号、最小 CPU、内存、磁盘空间同步到 Contenful 数据表,通过自动化[Github Action](https://github.com/Websoft9/docker-library/blob/main/.github/workflows/requirement_to_contentful.yml)实现。
2. 将 logo 图片同步到 Stackhub 项目的静态文件夹(/static/images),通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/logo.yml)实现。
## AppManage 镜像生成
发布镜像到 Dockhub 的 websoft9dev 组织下,通过自动化[Github Action](https://github.com/Websoft9/stackhub/blob/main/.github/workflows/appmanage_docker.yml)实现。
## 日志
Appmanage 日志采用 logging 生成,按自然日分割日志文件。日志路径:/var/lib/docker/volumes/w9appmanage_logs/\_data
其他微服务采用 Dockhub 公开镜像,用 docker 容器的日志访问命令即可查看。

View file

@ -14,7 +14,7 @@ What we do is integrating below stacks's API or interfaces to Cockpit console by
- [Duplicati](https://www.duplicati.com/): Backup software to store encrypted backups online
- [Redis](https://redis.io/): The open source, in-memory data store
- [Appmanage](https://github.com/Websoft9/websoft9/tree/main/appmanage): API for create and manage docker compose based application powered by Websoft9
- [websoft9-plugin](https://github.com/websoft9?q=plugin&type=all&language=&sort=): Cockpit packages powered by Websoft9
As Websoft9 is a complete product, we also offer:

View file

@ -1,45 +1,11 @@
# Developer Guide
## Version
Use *[[major].[minor].[patch]](https://semver.org/lang/zh-CN/)* for version serial number and [version.json](../version.json) for version dependencies
## Artifact
The core of DevOps is continue publish, the format of software publish is [Artifact制品库](https://jfrog.com/devops-tools/article/what-is-a-software-artifact/).
Websoft9 use below Artifact for different usage:
#### Dockerhub for image
Access [Websoft9 docker images](https://hub.docker.com/u/websoft9dev) on Dockerhub
#### Azure Storage package
Access [packages list](https://w9artifact.blob.core.windows.net/release?restype=container&comp=list) at Azure Storage
## Release
#### CHANGELOG format
```
## 0.3.0 release on 2023-06-06
1. appmanage docker update to 0.3.0
2. fix prestashop 502
```
### 制品库管理
版本管理部仅仅是对代码的管理,还需要对软件可执行成果物-制品的管理websoft9 项目会将所有成果作为公开制品。
#### 制品库选型
Dockerhub, Github packages, Azure artifacts, CODING 制品库
> 非容器类制品优先选择 Github packages
#### 制品库自动化
@ -56,7 +22,3 @@ Dockerhub, Github packages, Azure artifacts, CODING 制品库
自动化测试成功,同步 version_test.json 到 version.json 新制品正式发布。
### Contributor
- 类型标签Bug, enhancement, Documetation
- 过程标签PRD, Dev, QA(include deployment), Documetation