├── .gitignore
├── .github
├── FUNDING.yml
└── ISSUE_TEMPLATE
│ ├── improvement.md
│ ├── bug_report.md
│ └── feature_request.md
├── scripts
├── baseconfiguration
│ ├── install-git.sh
│ ├── full-update-os.sh
│ └── rpi-monitor.sh
└── zerow
│ ├── update-motion-eye.sh
│ └── motion-eye.sh
├── BACKUP_SERVER.md
├── CONTRIBUTING.md
├── schemas
└── main.puml
├── PI_ZERO_W_CAMERA.md
├── CODE_OF_CONDUCT.md
├── README.md
├── BASE_CONFIGURATION.md
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/*
2 | target/
3 | out/
4 |
5 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | patreon: romankh3
4 |
--------------------------------------------------------------------------------
/scripts/baseconfiguration/install-git.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | #
4 | # Install Git
5 | #
6 |
7 | sudo apt-get install git -y
8 |
--------------------------------------------------------------------------------
/scripts/baseconfiguration/full-update-os.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | #
4 | # Full update.
5 | #
6 |
7 | sudo apt-get update
8 | sudo apt-get upgrade
9 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/improvement.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Improvement
3 | about: Description of the improvment
4 | title: ''
5 | labels: enhancement
6 | assignees: romankh3
7 |
8 | ---
9 |
10 |
11 |
--------------------------------------------------------------------------------
/BACKUP_SERVER.md:
--------------------------------------------------------------------------------
1 | # Backup Server based on Raspberry Pi Zero W
2 | to be added.
3 |
4 | 1. Implement [Base Configuration](#base-congifuration-for-the-single-board-computers)
5 | 2. Mount USB-storage and connect it to USB 2.0
6 | 3. Install Samba.
--------------------------------------------------------------------------------
/scripts/zerow/update-motion-eye.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | #
4 | # These guidelines was taken from official wifi page:
5 | # https://github.com/ccrisan/motioneye/wiki/Install-On-Raspbian
6 | #
7 |
8 | # To upgrade to the newest version of motionEye, just issue:
9 | pip install motioneye --upgrade
10 | systemctl restart motioneye
11 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # How to become a contributor and submit your own code
2 |
3 | Pull requests are welcome.
4 |
5 | ## Contributing a Patch
6 |
7 | This is the project with guidelines, which describes the steps of how to improve home ecosystem.
8 | That's why the main thing is to test it on own Raspberry Pi before push the patch. It must be real experience of using some program/approach/smart-thing.
9 | All the patches will check this features before merge the changes.
10 |
11 | ## What contribute?
12 | It can be everything related to smart home and home ecosystem. It can be issues, marked as `good first issue`. These issues are created for contributing.
13 |
14 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: ''
5 | labels: bug
6 | assignees: romankh3
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 |
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 |
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 |
26 | **Additional context**
27 | Add any other context about the problem here.
28 |
--------------------------------------------------------------------------------
/schemas/main.puml:
--------------------------------------------------------------------------------
1 | @startuml
2 | title Raspberry Pi Home Ecosystem
3 |
4 | hide empty members
5 |
6 | object BaseConfiguration {
7 | Raspbian Light OS
8 | Install Git
9 | Enabled SSH
10 | Static Ip Address
11 | RPi Monitor
12 | }
13 |
14 | object MainServerModel3bPlus {
15 | Based on BaseConfiguration
16 | Mounted usb-storage
17 | Samba
18 | Transmission(Torrent Downloader)
19 | Plex media server
20 | Leanote host
21 | Pi-hole
22 | NextCloud
23 | }
24 |
25 | object PiZeroW {
26 | Based on BaseConfiguration
27 | MotionEye
28 | CUPS
29 | }
30 |
31 | BaseConfiguration --> MainServerModel3bPlus
32 | BaseConfiguration --> PiZeroW
33 |
34 |
35 |
36 | @enduml
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature request
3 | about: Suggest an idea for this project
4 | title: ''
5 | labels: enhancement
6 | assignees: romankh3
7 |
8 | ---
9 |
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 |
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 |
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 |
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 |
--------------------------------------------------------------------------------
/scripts/baseconfiguration/rpi-monitor.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | #
4 | # Install RPi-monitor.
5 | #
6 |
7 | # First, add https support:
8 | sudo apt-get install apt-transport-https ca-certificates
9 |
10 | # Add public key for repository access:
11 | sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 2C0D3C0F
12 |
13 | # Add RPi-monitor repository to the list of the available repos:
14 | sudo wget goo.gl/vewCLL -O /etc/apt/sources.list.d/rpimonitor.list
15 |
16 | # Update packages with new configurations:
17 | sudo apt-get update
18 |
19 | # Install RPi-monitor:
20 | sudo apt-get install rpimonitor
21 |
22 | # Add auto update package status:
23 | sudo /etc/init.d/rpimonitor install_auto_package_status_update
24 | sudo /etc/init.d/rpimonitor update
25 | sudo service rpimonitor restart
26 |
--------------------------------------------------------------------------------
/PI_ZERO_W_CAMERA.md:
--------------------------------------------------------------------------------
1 | # This is full description of [Camera monitoring based on Raspberry Pi Zero W](https://github.com/romankh3/raspberrypi-home-ecosystem/blob/master/README.md#camera-monitoring-based-on-raspberry-pi-zero-w)
2 |
3 | * [Requirements](#Requirements)
4 | * [Base Configuration](#Base-Configuration)
5 | * [MotionEye](#MotionEye)
6 | * [CUPS Wi-Fi Printer](#CUPS-Wi-Fi-Printer)
7 | * [Summary](#Summary)
8 |
9 | ## Requirements
10 | * microSD card with installing [Base Configuration](BASE_CONFIGURATION.md)
11 | * Raspberry Pi Zero W
12 | * Raspberry Camera V2.1
13 | * Power Supply
14 |
15 | ## Base Configuration
16 | This configuration ensure, that we `on the same page`.
17 | With this confifguration we can be sure, that everything will be ok with customing.
18 | This configuration can be found [here](BASE_CONFIGURATION.md)
19 |
20 | ## MotionEye
21 | It's very easy to install it, just execute bash script from `./scripts/zerow/motion-eye.sh`
22 | Type a few times `Y` to allow downloding and installing software.
23 |
24 | ## CUPS Wi-Fi Printer
25 |
26 | to be added
27 | ## Summary
28 |
29 | to be added
30 |
--------------------------------------------------------------------------------
/scripts/zerow/motion-eye.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | #
4 | # These guidelines was taken from official wifi page:
5 | # https://github.com/ccrisan/motioneye/wiki/Install-On-Raspbian
6 | ##
7 |
8 | # Install ffmpeg and v4l-utils:
9 | sudo apt-get install ffmpeg v4l-utils
10 |
11 | # Install libmariadbclient18 and libpq5 required by motion:
12 | sudo apt-get install libmariadbclient18 libpq5
13 |
14 | # Install motion:
15 | sudo wget https://github.com/Motion-Project/motion/releases/download/release-4.1.1/pi_stretch_motion_4.1.1-1_armhf.deb
16 | sudo dpkg -i pi_stretch_motion_4.1.1-1_armhf.deb
17 |
18 | # Install the dependencies from the repositories:
19 | sudo apt-get install python-pip python-dev libssl-dev libcurl4-openssl-dev libjpeg-dev libz-dev
20 |
21 | # Install motioneye, which will automatically pull Python dependencies (tornado, jinja2, pillow and pycurl):
22 | sudo pip install motioneye
23 |
24 | # Prepare the configuration directory:
25 | sudo mkdir -p /etc/motioneye
26 | sudo cp /usr/local/share/motioneye/extra/motioneye.conf.sample /etc/motioneye/motioneye.conf
27 |
28 | # Prepare the media directory:
29 | sudo mkdir -p /var/lib/motioneye
30 |
31 | # Add an init script, configure it to run at startup and start the motionEye server:
32 | sudo cp /usr/local/share/motioneye/extra/motioneye.systemd-unit-local /etc/systemd/system/motioneye.service
33 | sudo systemctl daemon-reload
34 | sudo systemctl enable motioneye
35 | sudo systemctl start motioneye
36 |
37 | # Remove .dep file
38 | sudo rm -f pi_stretch_motion_4.1.1-1_armhf.deb
39 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at roman.beskrovnyy@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Smart home ecosystem based on Raspberry Pi
2 | 
3 | Build your own smart home ecosystem based on Raspberry Pi. Use the guideline and/or bash scripts, which is tested and verified on real hardware and software.
4 | Why do you need it? It a great chance to build own smart home, which is customing as you want and all the features as you want.
5 |
6 |
7 | # Release Notes
8 |
9 | ### 0.1.0-SNAPSHOT
10 | * added [Base configuration for the single-board computers](#base-congifuration-for-the-single-board-computers)
11 | * add all scripts based on Base Configuration and tested it.
12 | # Parts
13 | * [Base congifuration for the single-board computers](#base-congifuration-for-the-single-board-computers)
14 | * [Main server based on Raspberry Pi Modeb 3b+](#main-server-based-on-raspberry-pi-modeb-3b)
15 | * [Camera monitoring based on Raspberry Pi Zero W](#camera-monitoring-based-on-raspberry-pi-zero-w)
16 | * [Monitoring home state with different sensors](#monitoring-home-state-with-different-sensors)
17 | * [Local internet customising based on Orange Pi R1](#local-internet-customising-based-on-orange-pi-r1)
18 | * [Backup server on Raspberry Pi Zero W](#Backup-server-on-Raspberry-Pi-Zero-W)
19 |
20 | ## Base congifuration for the single-board computers
21 | [Full description](BASE_CONFIGURATION.md) [:arrow_up:](#smart-home-based-on-raspberry-pi) Go Top.
22 | 1. Download [Raspbian OS](https://www.raspberrypi.org/downloads/raspbian/). All the guidelines describe the case with *Raspbian Stretch Lite*, the image with the only command line.
23 | 2. Get microSD card on 16GB+. I prefer SanDisk 16GB.
24 | 3. Format microSD card to FAT32 format. I use *CD Card Formatter* on MacOS.
25 | 4. Install downloaded image on microSD. I use *balenaEtcher* to do it.
26 |
27 | ## Main server based on Raspberry Pi Modeb 3b+
28 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
29 | 1. Implement [Base Configuration](#base-congifuration-for-the-single-board-computers)
30 | 2. Install torrent-downloader(to be added)
31 | 3. Mount USB-storage
32 | 4. Install own cloud
33 | 5. to be added
34 | ## Camera monitoring based on Raspberry Pi Zero W
35 | [Full description](PI_ZERO_W_CAMERA.md) [:arrow_up:](#smart-home-based-on-raspberry-pi)
36 | 1. Implement [Base Configuration](#base-congifuration-for-the-single-board-computers)
37 | 2. Install MotionEye using next [guidelines](https://github.com/ccrisan/motioneye/wiki/Install-On-Raspbian) or use our bash script `./srcripts/zerow/motion-eye.sh`
38 | 3. This raspberry can be used for other needs, too. On demand can be chosen features from list.
39 | ## Monitoring home state with different sensors
40 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
41 | In a nutshell:
42 | * CO2 Sensor
43 | * Humidity sensor
44 | * air temperature sensor
45 | * etc
46 | ## Backup server on Raspberry Pi Zero W
47 | [To be added](BACKUP_SERVER.md). Zero W should be enough to be a backup server.
48 | 1. Implement [Base Configuration](#base-congifuration-for-the-single-board-computers)
49 | 2. Mount USB-storage and connect it to USB 2.0
50 | 3. Install Samba.
51 |
52 | ## Local internet customising based on Orange Pi R1
53 | [:arrow_up:](#smart-home-based-on-raspberry-pi) To be added
54 |
55 | # Usage
56 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
57 | Step by step these guidelines can be used for creating own smart home ecosystem.
58 |
59 | You can use two ways to do it.
60 | * First is to go step by step throws the description.
61 | * Second is to run bash scripts, which are based on the guidelines.
62 |
63 | # Features
64 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
65 | * media server
66 | * Wi-Fi printer
67 | * gaming center
68 | * torrent-downloader
69 | * etc... to be added
70 |
71 | # Contributing
72 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
73 | If you have any ideas of how to improve this approach or you have ideas about new features - welcome!
74 | Full description can be found [HERE](CONTRIBUTING.md)
75 | # Lisence
76 | [:arrow_up:](#smart-home-based-on-raspberry-pi)
77 | This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
78 |
79 |
--------------------------------------------------------------------------------
/BASE_CONFIGURATION.md:
--------------------------------------------------------------------------------
1 | # This is detailed description of [Base Configuration](https://github.com/romankh3/raspberrypi-home-ecosystem#base-congifuration-for-the-single-board-computers).
2 |
3 | * [Requirements](#requeirements)
4 | * [Download Operation System](#download-operation-system)
5 | * [MicroSD Card](#microsd-card)
6 | * [Format microSD card to FAT32](#format-microsd-card-to-fat32)
7 | * [Flash Raspbian into microSD](#flash-raspbian-into-microsd)
8 | * [Turn on raspberry and set Wi-Fi connection](#turn-on-raspberry-and-set-wi-fi-connection)
9 | * [Install Git](#install-git)
10 | * [Set Static Ip Address](#set-static-ip-address)
11 | * [Install RPi-monitor](#install-rpi-monitor)
12 | * [Backup](#backup)
13 | * [Summary](#summary)
14 |
15 | ## Requeirements
16 | * Downloaded OS
17 | * microSD card 16GB
18 | * Raspberry Pi model 3b+
19 | * Display to setup first configuration
20 | * HDMI cable
21 | * keyboard
22 |
23 | ## Download Operation System
24 | I prefer the [Raspbian Official Operation System](https://www.raspberrypi.org/downloads/raspbian/).
25 |
26 | ## MicroSD card
27 | In my opinion, the capacity of the card should be 16GB. I prefer `SanDisk`.
28 |
29 | ## Format microSD card to FAT32
30 | Format microSD card to FAT32 format. I use [CD Card Formatter](https://www.sdcard.org/downloads/formatter_4/).
31 |
32 |
33 |
34 | ## Flash Raspbian into microSD
35 | Install downloaded image on microSD. I use [balenaEtcher](https://www.balena.io/etcher/) to do it. It's easy to use. It has one feature - mount `.img` files into the microDS card and nothing else!
36 |
37 |
38 |
39 | ## Turn on raspberry and set Wi-Fi connection
40 | 1. Plug in microSD card into Raspberry Pi and on the single-board PC.
41 |
42 | 2. Next, put default `user:password`: `pi:raspberry`.
43 |
44 | 3. Next, should be configured Wi-Fi connection and SSH to be enabled: `$ sudo raspi-config`
45 |
46 | And configuration window will open and looks like picture below:
47 |
48 |
49 | 4. Next, choose `Interfacing Options` and set `SSH` enable. This will help to connect to Raspberry Pi via SSH.
50 |
51 | 5. After that, go back and go to `Network Options` and choose `Wi-Fi`. Fill the name and password of the Wi-Fi.
52 |
53 | 6. To be sure, that these changes are working as expected, reboot Raspberry: `$ sudo reboot`
54 |
55 | 7. Next, need to understand the `IP address` of the Raspberry to connect to: `$ sudo ifconfig`
56 |
57 | Next we can find the it:
58 |
59 |
60 |
61 |
62 |
63 | And `192.168.0.104` is an IP address of the Raspberry Pi.
64 |
65 | Summary: all the actions will be executed from PC via SSH connection. SSH connection it's out of the scope, so google it :)
66 |
67 | ## Install Git
68 | This is the light version of the Raspbian, that's why before using `scripts` from the project, we need to clone it, for this purpose install git:
69 |
70 | `$ sudo apt-get install git -y`
71 |
72 | ## Set Static Ip Address
73 | To be sure, that every time Raspberry will be on the same IP, this needs to be configured:
74 |
75 | First, we need to understand the main IP address of the router. For example, in this case, it's `192.168.0.1`. Or it can be `192.168.1.1`.
76 |
77 | Open the dhcpcd config:
78 |
79 | `$ sudo nano /etc/dhcpcd.conf`
80 |
81 | and write down below
82 |
83 | ```
84 | nodhcp
85 |
86 | interface eth0
87 | static ip_address=192.168.0.222/24
88 | static routers=192.168.0.1
89 | static domain_name_servers=192.168.0.1
90 |
91 | interface wlan0
92 | static ip_address=192.168.0.222/24
93 | static routers=192.168.0.1
94 | static domain_name_servers=192.168.0.1
95 |
96 | interface wlan1
97 | static ip_address=192.168.0.222/24
98 | static routers=192.168.0.1
99 | static domain_name_servers=192.168.0.1
100 |
101 | ```
102 |
103 | It looks like below:
104 |
105 |
106 | I choose `192.168.0.222` as a static ip address and set to all interfaces, which can be.
107 |
108 | Next, reboot raspberry and watch to static IP instead of the dynamic.
109 |
110 | `$ sudo reboot`
111 |
112 | ## Install RPi-monitor
113 | Raspberry should be monitored and `RPi-monitor` - it's the tool, which can help with it. It developed for Raspbian and it's fast and light.
114 | It shows the next data:
115 | * Version of the OS
116 | * Uptime
117 | * CPU
118 | * Temperature
119 | * Memory
120 | * SD Card memory
121 |
122 | Looks like picture below:
123 |
124 |
125 |
126 | I really like it, moreover it has `statistics` section, when can be sound data from last reboot, see below:
127 |
128 |
129 |
130 | Can be used [bash script](https://github.com/romankh3/raspberrypi-home-ecosystem/blob/master/scripts/baseconfiguration/rpi-monitor.sh) from the project.
131 |
132 | So, go ahead:
133 |
134 | First, add `https` support:
135 |
136 | `$ sudo apt-get install apt-transport-https ca-certificates`
137 |
138 | Add the public key for repository access:
139 |
140 | `$ sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 2C0D3C0F`
141 |
142 | Add RPi-monitor repository to the list of the available repos:
143 |
144 | `$ sudo wget goo.gl/vewCLL -O /etc/apt/sources.list.d/rpimonitor.list`
145 |
146 | Update packages with new configurations:
147 |
148 | `$ sudo apt-get update`
149 |
150 | Install RPi-monitor:
151 |
152 | `$ sudo apt-get install rpimonitor`
153 |
154 | It's the last step for installing RPi-monitor. Let's do extra configurations.
155 |
156 | Add auto update package status:
157 |
158 | ```
159 | $ sudo /etc/init.d/rpimonitor install_auto_package_status_update
160 | $ sudo /etc/init.d/rpimonitor update
161 | $ sudo service rpimonitor restart
162 | ```
163 |
164 | Now it's available in `192.168.0.222:8888`.
165 |
166 | ## Backup
167 | This is a good time to do the backup. What does it mean? It means that needs to create `.img` file of the microSD card with Base Configuration to be sure that if something will be bad, we can easily set it again, just mount own customized image.
168 | //todo adds the link to the base configuration image.
169 |
170 | Should be found the name of the microSD card put it into command below
171 |
172 | For people who use linux/macOS it's really easy. I use macOS, so will tell how to do it on macboor:
173 |
174 | `$ sudo dd if=/dev/name_of_the_microSdCard of=/home/Username/Desktop/raspberrypi-backup.img`
175 |
176 | That’s it. The only thing is highly recommended is that you properly eject the SD before taking it out of the slot physically:
177 |
178 | `$ sudo diskutil eject /dev/name_of_the_microSdCard`
179 |
180 | **Full Description of how to make the backup without empty space will be added later**
181 |
182 | ## Summary
183 |
184 | It's all that I wanted to add to the Base Configuration stage. This is the base of all the instances of all Raspberry Pi PCs.
185 |
186 | Good luck!
187 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------