Skip to content

Commit fe5a401

Browse files
committed
Readme: Updated
1 parent 2f3e63b commit fe5a401

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

LICENSE LICENSE.md

File renamed without changes.

README.md

+22-15
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
1-
# Community Wiki
2-
3-
https://github.com/Cloudbox/Community/wiki
1+
# Community Repo
42

3+
Community Repository for Unofficial Cloudbox Add-ons
54

6-
# Community Repo
5+
## Requiremements
76

8-
Community Repo for addons
7+
- [Cloudbox](https://github.com/Cloudbox/Cloudbox/)
98

109

11-
## Cloning the Repo:
10+
## Clone Repo
1211

1312
```bash
14-
git clone https://github.com/Cloudbox/Community.git ~/community
13+
git clone https://github.com/Cloudbox/Community.git ~/community && cd ~/community
1514
```
1615

17-
## Password File Setup:
16+
## Password File
1817

19-
If you have setup an Ansible vault password file for Cloudbox, you will need to add its location to `~/community/ansible.cfg`:
18+
If you have setup an Ansible vault password file for Cloudbox, you will need to add its location to the Community Repo folder's `ansible.cfg` file.
19+
20+
1. Open `~/community/ansible.cfg`
2021

21-
1. To edit:
2222
```bash
2323
nano ~/community/ansible.cfg
2424
```
2525

26-
2. Add line (with path to your vault password file):
26+
2. Add entry for `vault_password_file` pointing to the path of your Cloudbox vault password file.
27+
2728
```ini
2829
vault_password_file = ~/.ansible_vault
2930
```
3031

3132
3. Should now look like this:
33+
3234
```ini
3335
[defaults]
3436
inventory = ~/cloudbox/inventories/local
@@ -40,14 +42,19 @@ If you have setup an Ansible vault password file for Cloudbox, you will need to
4042
vault_password_file = ~/.ansible_vault
4143
```
4244

45+
1. Save and exit: <kbd class="platform-all">Ctrl + X</kbd> <kbd class="platform-all">Y</kbd> <kbd class="platform-all">Enter</kbd>
46+
4347

44-
## Usage:
48+
## Usage
4549

4650
```bash
47-
cd ~/community
48-
sudo ansible-playbook community.yml --tags ROLE
51+
sudo ansible-playbook community.yml --tags <ROLENAME>
4952
```
50-
## Roles:
53+
54+
See [wiki](https://github.com/Cloudbox/Community/wiki) for setup guides.
55+
56+
57+
## Roles
5158

5259
- **airsonic**
5360
- **calibre-rdp** - Media path set to `/Media/Books`

0 commit comments

Comments
 (0)