Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2nistechworld/yoc

Your Own Cloud - automatic install script
https://github.com/2nistechworld/yoc

Last synced: 4 days ago
JSON representation

Your Own Cloud - automatic install script

Awesome Lists containing this project

README 

        
# YOC: Your Own Cloud




## Updates

2024-09-21:

- Remove Home Assistant

- Update to Traefik V3

- Some cosmetic changes in compose files files

- Configure new PASSWORD_HASH for WG-EASY



2024-09-20: 

- Add Owncloud

- Update Traefik configuration for Nextcloud

- Ask if you want to use Mobile Client push notification with Vaultwarden.



2024-09-08: 

- Add paperless-ngx



2024-09-07: 

- Update Seafile to Version 11

- Update Immich docker compose configuration

- Add Vaultwarden [Mobile Client push notification](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-Mobile-Client-push-notification)

- update wg-easy docker image



2023-08-15:

- Add Audiobookshelf and Home Assistant



2023-08-06: 

- Add more informations into the README (thanks u/redoubledit)

- Add .uninstall.sh script to delete YOC

- Modify the beahavior when the script install.sh is launched on an already existing installation of YOC

- Modify the yoc cli tool to be able to start / stop services using several containers

    - **yoc stop seafile** will stop the three containers running Seafile.



## Description

This installation Wizard will install the followings services depending of your choices using docker and docker compose

- [Traefik](https://traefik.io/traefik): Reverse proxy manager, to make sure, you are not exposing your server to the public.

- [Vaultwarden](https://github.com/dani-garcia/vaultwarden): Password manager, to store passwords, one time passwords for two factor authentication and secret documents and notes.

- [Seafile](https://www.seafile.com/): Files storage, sync and sharing solution. A good self hosted equivalent of DropBox / OneDrive.

- [Nextcloud](https://nextcloud.com/): All in one Cloud solution, for file storing and sharing, document collaboration, calendar and contact synchronisation, and much more.

- [Owncloud](https://owncloud.com/): Open-source file sync, share and content collaboration software that lets teams work on data easily from anywhere, on any device.

- [wg-easy](https://github.com/wg-easy/wg-easy): Wireguard VPN, to make sure, only certain people can access your services via a secure VPN.

- [AdGuard Home](https://adguard.com/): Server side ad blocking, to remove ads and other malicious content before it reaches your computer. Can also act as a DNS/DHCP server.

- [Immich](https://immich.app/): Photos library, to make photo collection easy, can include automatic face recognition, tagging, and much more, great Google/Apple photo alternative.

- [Paperless-ngx](https://docs.paperless-ngx.com/): Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.



## OS Supported

### Debian

- Debian Bookworm 12 (Stable)

- Debian Bullseye 11 (Oldstable)



### Ubuntu

- Ubuntu Lunar 23.04

- Ubuntu Kinetic 22.10

- Ubuntu Jammy 22.04 (LTS)

- Ubuntu Focal 20.04 (LTS)



## Features

- Install docker and docker compose if not installed

- Install services using docker and docker compose

- Configure the reverse proxy (Traefik) using your own domain or a local domain (yoc.local)

    - If you install Traefik you will be asked if you want to use Cloudflare to perform a DNS Challenge for SSL Certificate with Let's Encrypt using your own domain, also you will be asked if you want to create DNS Record on Cloudflare for the services selected using your [Cloudflare API Key](https://github.com/2nistechworld/yoc#how-to-get-your-cloudflare-api-key).

    - If not, a local domain **yoc.local** will be used.

- Create random password for the services selected.

- If AdGuard Home is installed, DNS entries will be created for your services.

- If AdGuard Home and Wireguard are installed, Wireguard will use Addguard Home as DNS server.

- [YOC CLI](https://github.com/2nistechworld/yoc#yoc-cli-tool) tools to manage your services 

## Dependencies

- git

- docker and docker compose

- whiptail



## Before starting the installation

- Install git

```

(sudo) apt install git

```

- Having your domain name and Cloudfalre API Key for the domain you want to use.



## Starting the installation

```

git clone https://github.com/2nistechworld/yoc.git

cd yoc

bash install.sh

```

And follow the instructions.



## YOC CLI Tool




## How to get your Cloudflare API Key

To get you API token go to https://dash.cloudflare.com/profile/api-tokens



- Click Create Token

- choose Edit zone DNS template

- Configure like this with your own domain




- Continue to summary and save your API token



## Files structure

```

yoc/

├── compose_files

│   ├── adguardhome.yaml

|   ├── audiobookshelf.yaml

|   ├── immich.yaml

│   ├── nextcloud.yaml

│   ├── owncloud.yaml

│   ├── seafile.yaml

│   ├── traefik.yaml

│   ├── vaultwarden.yaml

│   ├── paperless-ngx.yaml

│   └── wg-easy.yaml

├── containers_data

│   ├── adguardhome

|   ├── audiobookshelf

|   ├── immich

│   ├── nextcloud

│   ├── owncloud

│   ├── seafile

│   ├── traefik

│   ├── vaultwarden

│   ├── paperless-ngx

│   └── wireguard

└── infos.txt

```



## Thanks

This project has been inspired by [YAMS](https://yams.media/)



Also please support the developpers of:

- [Traefik](https://traefik.io/traefik)

- [Vaultwarden](https://github.com/dani-garcia/vaultwarden)

- [Seafile](https://www.seafile.com/)

- [Nextcloud](https://nextcloud.com/)

- [Owncloud](https://owncloud.com/)

- [wg-easy](https://github.com/wg-easy/wg-easy)

- [AdGuard Home](https://adguard.com/)

- [Immich](https://immich.app/)

- [Paperless-ngx](https://docs.paperless-ngx.com/)