Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +diff --git a/src/en/en/book/.nojekyll b/src/en/en/book/.nojekyll new file mode 100644 index 0000000..f173110 --- /dev/null +++ b/src/en/en/book/.nojekyll @@ -0,0 +1 @@ +This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/src/en/en/book/404.html b/src/en/en/book/404.html new file mode 100644 index 0000000..004db28 --- /dev/null +++ b/src/en/en/book/404.html @@ -0,0 +1,186 @@ + + +
+ + +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +git
+Welcome to the SelfPrivacy Project Contribution guide. This document is brought to you by SelfPrivacy team to help people willing to contribute into our project. This document contains quick explanation of everything you'll need to help the project growing, developing and improving.
+This document is divided into two parts and depending on your experience of working with a technical projects, you may be interested in reading both or just one of the parts.
+If you have a basic understanding of git version control system and had previous experience of working with Gitea git server, then you'll probably be interested in skipping the first part as it contains the most basic concepts of git
explained and illustrated using Gitea as an example.
In case if all(or some) of the mentioned things is relatively new to you - feel free to look into first part. It covers the minimal amount of the things that you'll need to get started.
+Git - is one of the most popular version control systems, used by millions of developers and libre/open source contributors all over the world.
+This is very powerful tool that provides your files(mostly, your code) with change tracking, fault tolerance, versioning and work separation for teams and different environments. Such power is provided at a cost of implementing a couple of new concepts that needed to be understood before starting to work with git
. Those concepts are not complicated so it's not a big challenge to understand them.
To tell long story short, git
expects code to be stored on the remote server in the repository. You work with code by downloading(cloning) repository to your computer. When you make changes to your local copy of a repository, you give git
a command to syncronize changes in your local copy of repository with remote one. When you syncronize your changes, git server(Gitea in our case) records each change you've done. If something goes wrong with your code, you can rollback to it previous version.
As far as I mentioned, git
expects you to store your code in the remote repository. For this reason the remote server required to store your code. You might have already heard about a couple. The most popular include:
The problem of this services is that they are owned by big corporations like Microsoft or Atlassian, so it means that when they offer to hold your code for no cost, they use access to your private data as a fee for using their development in which they invest millions of dollars(it fully pays off itself, in fact).
+As we are the project that fights to allow people to defend their privacy, we can't trust our code to those information-devouring companies. For this reason we chosen a git server that can be hosted on a self-hosted private server that server our developments for the sake of community. For us this server is Gitea. It can be accessed here.
+Except repositories and cloning, concepts of git, you'll need to be
+acknowledged with are: commit
and push
.
+Author commits changes to this article :) +
+Not to bore you completely with the theory, let's jump to the part where all of the fun begins,
+First of all, go to the link, where our Gitea can be found: https://git.selfprivacy.org
+You will be presented with the following picture:
+You will need an upper right corner of this webpage:
+ +Push a Register
button
You will be presented with quite standard registration form:
+Complete the registration. Do not forget to create a strong and memorable password.
+After completing the registration, log into the Gitea.
+Remember, I mentioned a couple of new concepts that git
introduces, right? Forking - is one of them. But before I explain what does it mean, let me briefly explain how to access existing repositories.
+SelfPrivacy webpage repository page +
+Now, let's go back to forking. When you want to make some changes to the sources in the repository, you can't commit changes to the original one directly, unless you're granted permission to. Usually, the only people that have permission to directly modify the repository, are the core development team. For all the contributors there's different apprach exist.
+Contributors can modify the original repository by creating an identical copy of it on their own account, making changes to it and requesting moderators to overwrite(or merge) files with changed ones. Moderator reviews changes before approving them, gives some comments regarding the changes and if everything is OK, then he/she accepts proposed changes.
+++Forking - Creating an identical copy of a repository on your own account of a git server
+
To fork a git repository, you'll have to push a Fork
button(can be found at the upper right corner of the repository interface):
When you'll fork the repository, the identical one will appear in your account and you'll be able to make modifications to it.
+Remember, I said that wheen you're working with a code inside of a git repository, to make some changes, you'll firstly have to clone it to your computer, right?
+Now it's time for me to show you how to begin making changes to your code.
+To clone a repository, you'll have to use a CLI git
utility. let's begin with opening your terminal:
Microsoft Windows users would have to open a "PowerShell" application. +Mac users will be able to find a "Terminal" app in the "Utilities" folder.
+First of all, you'll have to pick a location where you would like to store the repository with a code. It can be specially created, deticated folder, or just your home directory
+For our example let's pick home directory as the folder to which we'll clone our repository(home folder opened by default by the most shells).
+Let's clone a webpage repository to our computer. To do so, please run the following command:
+git clone https://git.selfprivacy.org/ilchub/selfprivacy-frontend
+
+
+If you'll now open the file manager, you'll see the newly cloned repository(which is now just a folder on our disk :)
+ +Editing of a project is a subject of quite personal taste. From the point of getting the code to your computer, it's totally up to you, what code editor to choose. Author used (Neo)Vim and VS Code to write the following article.
+ +Author, writing article in the VS Code
+Feel free to explore the repository and edit it in a way you want.
+After you've made all desired changes, time comes to push your changes to the Gitea server to store them in a safe place and keep track of them. In the world of git
, making changes to the source code is described by pretty self-explainable word - commiting
. To commit changes to the code, we'll again need to use some CLI skills.
Open your terminal and make sure that you're currently in the same directory that code resides in. Your current directory can be determined by running the following command:
+pwd
+
+and it defaults to your home folder:
+ +In case if you're not in the same directory with your code, you can change by running the following command:
+cd /path/to/the/directory/with/my/code
+
+After that you can again rerun pwd
to make sure that directory is correct.
When the requirement of being in the correct directory is met, you can start commiting your changes.
+First of all, please run the following command:
+git add .
+
+This command will result in git searching recursively through the entire directory for changes you've made in the files:
+ +This command will produce no output so don't be worried by that fact.
+After searching for changes, your next step will be to add them to the queue for syncronization with the Gitea server. To do so, please run the following:
+git commit -m "Brief explanation of changes"
+
+
+This command will output all changes that were made to the folder(of course in case if you defined a correct search scope with git add
command).
That's the point when all your changes are indexed and queued for being pushed to the remote server. To push changes to the remote server, please run:
+git push -u origin master
+
+
+Right after pushing your changes to the remote repository, it's rather good idea to review them. If you'll visit your repository, you'll see that the last commit on the page have changed:
+ +You can click the "Commits" button to see the history of all your commits:
+ +If you'll click onto one of the commits, you will be able to see what things changed since last push:
+ +Gitea will show you the detailed explanation on what have been added to your code and what have been removed.
+That's how changes review works.
+Note: You can add comments to each line by clicking on it.
+https://git.selfprivacy.org/ilchub/selfprivacy-frontend
+We do our best to make our service convenient for common users:
+Yes, you could use kuburnetis. But why when immutability is ensured by NixOS?
+Stack: NixOS, python, flutter
+Flutter/Dart was chosen because of the speed and smoothness of the UI and cross-platform.
+NixOS + Python. NixOS was chosen because of its reproducibility, python because of its versatility and popularity.
+We do not get paid by any service providers! We are not affiliated with them in any way. We chose them purely for professional reasons. But we do not exclude partnership in the future.
+Hetzer was chosen because of low price and acceptable level of service, quality REST API. Wasn't noticed any privacy or data collection issues.
+Candidates:
+There's also free Oracle Cloud, but where you don't pay, you're usually a commodity.
+Cloudlare reliable, free. Probably collects data, otherwise it's hard to explain why proxy other people's traffic for free. In our case we use it only as a DNS-server and do not proxy anything. In the future we will replace it with self-hosted DNS, as soon as we solve the reliability problem.
+Backblaze is free or times cheaper than AWS. Not seen in data collection. Publishes in open source the hardware it runs on. And also shares very useful statistics about disk failures, on the basis of which you can choose the most reliable and tested one. In the future, perhaps, we will replace it with a self-hosted or p2p solution. Now it is not the main priority, because the data is encrypted, and the service provider sees only the ip of your server, but not the home one.
+ +Strategy - digital independence
+In the early days of the Internet, it was decentralized. The system administrator had to take care of everything. Nowadays, not much has changed, and whoever wants a private IT infrastructure has to build it himself in almost the same way as 20 years ago, or use non-private cloud services.
+We've stepped back, sideways and forward. We have developed a tool that automatically creates your own private IT-infrastructure without involving a system administrator. Using such an infrastructure is almost as easy as using cloud services. At least, that is what we strive for.
+SelfPrivacy App/Server may not need to be upgraded, it will still work. But then you will lose patches, possibly critical ones, and new handy features. You can keep an eye on our repository or look at roadmap.md for changes.
+ +nextcloud
+ +commit -> push -> webhook -> checks -> selfprivacy.org
+commit -> push -> webhook -> checks -> mdbook -> translate -> docs.selfprivacy.org
+Mobile App
+How to help the project:
+Unfortunately, you can't make a mass product on enthusiasm. Many choose to go the commercial route, but that imposes limitations:
+I'm struggling to find another way. The best of which is direct regular user funding. At least $1 a month.
+++As of 2019, I'm investing a noticeable chunk of my family budget and time into the project. Because I am confident in the necessity of SelfPrivacy. Kirill Zholnay (founder).
+
83sxCzpY9Be2a7CCkrML6JamwLoQ6C7h6h9E282LqNJjZC7Gx2aVcNR9Kz8Mqrix8s7zXyUpWgtVYQByraqqopx38Y4xDGQ
https://liberapay.com/SelfPrivacy.org/
+ +Important for registering with services, receiving notifications, and as a server for Delta.Chat. Tutanota and Protonmail do not support third-party email clients and Delta.Chat (no IMAP).
+Messages for user+alias@domain.com
will come to user@domain.com
.
The message for user-dir@domain.com
will create a dir
directory in the user@domain.com
mailbox. All mail for user-dir@domain.com
will arrive in the dir
directory.
It may seem undeveloped or outdated to some. But it has the advantage of simplicity and small amount of code and bugs, which increases [security.md] and [privacy.md]. But it is better to use email clients and disable the web interface in SelfPrivacy App. This will reduce the attack surface and the risks of hacking.
+user-w@domain.com
- for registering with web servicesuser-pay
- payment systemsuser+tmp@domain.com
. By aliases convenient to filter and mass delete mails. It is also convenient to find out exactly where your mail was leaked from.Most importantly, control your own digital life. Your communications, data, meta-information belong only to you!
+To that end, we've implemented:
+https://nlnet.nl/foundation/ want support )
+ +SelfPrivacy - mobile app deploys a server with ready-to-use services:
+The current release is not yet ready for everyday use by an unskilled user.
+ +