|
1 | | - |
2 | | -# CouchDB 自动化安装与部署 |
3 | | - |
4 | | -本项目是由 [Websoft9](https://www.websoft9.com) 研发的 [CouchDB](https://couchdb.apache.org/) 自动化安装程序，开发语言是 Ansible。使用本项目，只需要用户在 Linux 上运行一条命令，即可自动化安装 CouchDB，让原本复杂的安装过程变得没有任何技术门槛。 |
5 | | - |
6 | | -本项目是开源项目，采用 LGPL3.0 开源协议。 |
7 | | - |
8 | | -## 配置要求 |
9 | | - |
10 | | -安装本项目，确保符合如下的条件： |
11 | | - |
12 | | -| 条件 | 详情 | 备注 | |
13 | | -| ------------ | ------------ | ----- | |
14 | | -| 操作系统 | CentOS7.x, Ubuntu18.04 | 可选 | |
15 | | -| 公有云| AWS, Azure, 阿里云, 华为云, 腾讯云 | 可选 | |
16 | | -| 私有云| KVM, VMware, VirtualBox, OpenStack | 可选 | |
17 | | -| 服务器配置 | 最低1核1G，安装时所需的带宽不低于10M | 建议采用按量100M带宽 | |
18 | | - |
19 | | -更多请见 [官方 System requirement](https://docs.couchdb.org/en/latest/install/index.html) |
20 | | - |
21 | | -## 组件 |
22 | | - |
23 | | -包含的核心组件为：可选 CouchDB |
24 | | - |
25 | | -更多请见 [参数表](/docs/zh/stack-components.md) |
26 | | - |
27 | | -## 本项目安装的是 CouchDB 最新版吗？ |
28 | | - |
29 | | -本项目通过[CouchDB 官方仓库源](https://docs.couchdb.org/en/latest/install/index.html)安装，每次安装均可保证为最新版本。 |
30 | | - |
31 | | -版本号，请通过[官方下载](https://couchdb.apache.org/)页面查看 |
32 | | - |
33 | | -我们会定期检查版本准确性，并测试此项目，以保证用户可以顺利安装所需的CouchDB版本。 |
34 | | - |
35 | | -## 安装指南 |
36 | | - |
37 | | -以 root 用户登录 Linux，运行下面的**一键自动化安装命令**即可启动自动化部署。若没有 root 用户，请以其他用户登录 Linux 后运行 `sudo su -` 命令提升为 root 权限，然后再运行下面的脚本。 |
38 | | - |
39 | | -``` |
40 | | -wget -N https://raw.githubusercontent.com/Websoft9/ansible-linux/main/scripts/install.sh; bash install.sh -r couchdb |
41 | | -``` |
42 | | - |
43 | | -脚本后启动，就开始了自动化安装，必要时需要用户做出交互式选择，然后耐心等待直至安装成功。 |
44 | | - |
45 | | -**安装中的注意事项：** |
46 | | - |
47 | | -1. 操作不慎或网络发生变化，可能会导致SSH连接被中断，安装就会失败，此时请重新安装 |
48 | | -2. 安装缓慢、停滞不前或无故中断，主要是网络不通（或网速太慢）导致的下载问题，此时请重新安装 |
49 | | - |
50 | | -多种原因导致无法顺利安装，请使用我们在公有云上发布的 [CouchDB 镜像](https://apps.websoft9.com/couchdb) 的部署方式 |
51 | | - |
52 | | -## License |
53 | | - |
54 | | -[LGPL-3.0](/License.md), Additional Terms: It is not allowed to publish free or paid image based on this repository in any Cloud platform's Marketplace. |
55 | | -Copyright (c) 2016-present, Websoft9 |
56 | | - |
57 | | -## 文档 |
58 | | - |
59 | | -文档链接：https://support.websoft9.com/docs/couchdb/zh |
60 | | - |
61 | | -## FAQ |
62 | | - |
63 | | -- 命令脚本部署与镜像部署有什么区别？请参考：[镜像部署-vs-脚本部署](https://support.websoft9.com/docs/faq/zh/bz-product.html#镜像部署-vs-脚本部署) |
64 | | -- 本项目支持在 Ansible Tower 上运行吗？支持 |
| 1 | +# CouchDB Cloud Installer |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## Introduction |
| 6 | + |
| 7 | +[English](/README.md) | [简体中文](/README-zh.md) |
| 8 | + |
| 9 | +**CouchDB Cloud Installer**, developed by [Websoft9](https://www.websoft9.com), is an automatic installation program of [CouchDB](http://couchdb.apache.org/) based on Ansible and shell. It helps user install CouchDB and pre-configure required items automatically and users only need to run a command on Linux. It simplifies the complicated installation and initialization process. |
| 10 | + |
| 11 | +## System Requirement |
| 12 | + |
| 13 | +System Requirement to install this repository are as following： |
| 14 | + |
| 15 | +| Conditions | Details | Notes | |
| 16 | +| ------------------- | --------------------------------| -------------------- | |
| 17 | +| Operating System | CentOS7.x, Ubuntu20.04, Amazon Linux2 | Optional | |
| 18 | +| Public Cloud | AWS, Azure, Alibaba Cloud, HUAWEI ClOUD, Tencent Cloud | Optional | |
| 19 | +| Private Cloud | KVM, VMware, VirtualBox, OpenStack | Optional | |
| 20 | +| Server Configuration | vCPU no less than 1 core, Memory no less than 1 GIB, Storage no less than 20 GB, Swap no less than 2GB |Bandwidth no less than 100M| |
| 21 | + |
| 22 | +To learn more information, please view [Installation & Configuration](https://github.com/apache/couchdb-documentation/blob/main/requirements.txt). |
| 23 | + |
| 24 | +## Ecosystem |
| 25 | + |
| 26 | +Core components of this repository: Nginx, CouchDB |
| 27 | + |
| 28 | +Learn more about [Parameters](/docs/stack-components.md). |
| 29 | + |
| 30 | +## Installation |
| 31 | + |
| 32 | +You can install it by thi Cloud Installer solution all in one. In addition, you can deploy image published on major Cloud Platform by Websoft9. |
| 33 | + |
| 34 | +#### All-in-one Installer |
| 35 | + |
| 36 | +Run the automatic installation script with **root** authority to start the installation. If necessary, users need to make interactive choices, and then wait patiently until the installation is successful. |
| 37 | + |
| 38 | +``` |
| 39 | +$ sudo su - |
| 40 | +$ wget -N https://raw.githubusercontent.com/Websoft9/ansible-linux/main/scripts/install.sh; bash install.sh -r couchdb |
| 41 | +``` |
| 42 | + |
| 43 | +If the network is broken or blocked, SSH will be interrupted and the installation will fail. Please reinstall. |
| 44 | + |
| 45 | +#### Image on Cloud |
| 46 | + |
| 47 | +Follow our [CouchDB image](https://apps.websoft9.com/couchdb) for installation on major Cloud Platform. |
| 48 | + |
| 49 | +## Documentation |
| 50 | + |
| 51 | +**[Administrator Guide](https://support.websoft9.com/docs/couchdb)** |
| 52 | + |
| 53 | +## License |
| 54 | + |
| 55 | +[LGPL-3.0](/License.md), Additional Terms: It is not allowed to publish free or paid image based on this repository in any Cloud platform's Marketplace. |
| 56 | + |
| 57 | +Copyright (c) 2016-present, Websoft9 |
| 58 | + |
| 59 | +This program provided by Websoft9 contains a series of software with separate copyright notices and license terms. Your use of the source code for the software included is subject to the terms and conditions of its own license. |
| 60 | + |
| 61 | +## FAQ |
| 62 | + |
| 63 | +#### How to install and view the latest release? |
| 64 | + |
| 65 | +This repository install way is Package isntallation , you can view the version from [Official URL](https://docs.couchdb.org/en/latest/install/unix.html#installation-using-the-apache-couchdb-convenience-binary-packages). |
| 66 | +We will check [Release version](https://github.com/Websoft9/ansible-couchdb/releases) regularly. Update and test this project to ensure that users can successfully install the required version of CouchDB. |
| 67 | + |
| 68 | +#### Can I run this repository on Ansible Tower? |
| 69 | + |
| 70 | +Yes. |
| 71 | + |
| 72 | +#### Although the results of the deploy by image are consistent with the results of deploy by script, what is the difference between the two deployment methods? |
| 73 | + |
| 74 | +Suggest you read the document [Deploy by Image vs Deploy by Script](https://support.websoft9.com/docs/faq/bz-product.html#deployment-comparison). |
| 75 | + |
0 commit comments