Skip to content

Commit 055e64b

Browse files
committed
Update README.md
1 parent 501995d commit 055e64b

1 file changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# pyproxy_ansible
2-
Deploy pyproxy with ansible
1+
<div align="center">
2+
<h1>pyproxy Ansible</h1>
3+
</div>
4+
5+
**pyproxy Ansible** is an Ansible role for deploying the [pyproxy](https://github.com/6C656C65/pyproxy) project.
6+
7+
## **Deployment Methods**
8+
9+
| Feature | Supported |
10+
| -------------------- | --------- |
11+
| From source ||
12+
| Using Docker run ||
13+
| Using Docker Compose ||
14+
15+
## 📦 **Installation**
16+
17+
You can add the role to your playbook as a submodule. For example:
18+
19+
```bash
20+
git submodule add https://github.com/6C656C65/pyproxy_ansible roles/pyproxy
21+
```
22+
23+
## 🔧 **Configuration**
24+
25+
By default, the installation method uses Docker Compose.
26+
You can change the installation method and adjust other settings in the `./defaults/main.yml` file, either directly or by overriding variables in your playbook.
27+
28+
## 📄 **License**
29+
30+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
31+
32+
## 🤝 **Contributing**
33+
34+
Contributions are always welcome and appreciated! If you'd like to improve this project, feel free to fork the repository and submit a pull request. Whether it's fixing bugs, adding new features, improving documentation, or suggesting enhancements, every contribution helps. Please ensure you follow the coding standards and test your changes before submitting. Let's build something great together!

0 commit comments

Comments
 (0)