selfprivacy.org.app/README.md

58 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2021-10-26 17:57:06 +03:00
# SelfPrivacy App
2020-11-29 22:07:46 +02:00
2022-09-29 12:08:04 +03:00
SelfPrivacy — is a platform on your cloud hosting, that allows to deploy your own private services and control them using mobile application.
2020-11-29 22:07:46 +02:00
2023-05-19 11:45:22 +03:00
To use this application, you'll be required to create accounts of different service providers. Please reffer to this manual: https://selfprivacy.org/docs/getting-started/
2020-11-29 22:07:46 +02:00
2022-09-29 12:08:04 +03:00
Application will do the following things for you:
2020-11-29 22:07:46 +02:00
2022-09-29 12:08:04 +03:00
1. Create your personal server
2. Setup NixOS
3. Bring all services to the ready-to-use state. Services include:
2020-11-29 22:07:46 +02:00
2022-09-29 12:08:04 +03:00
* E-mail, ready to use with DeltaChat
* NextCloud - your personal cloud storage
* Bitwarden — secure and private password manager
* Pleroma — your private fediverse space for blogging
* Jitsi — awesome Zoom alternative
* Gitea — your own Git server
* OpenConnect — Personal VPN server
2020-11-29 22:07:46 +02:00
2022-09-29 12:08:04 +03:00
**Project is currently in open beta state**. Feel free to try it. It would be much appreciated if you would provide us with some feedback.
## Building
Supported platforms are Android, Linux, and Windows. We are looking forward to support iOS and macOS builds.
For Linux builds, make sure you have these packages installed:
|Arch-based|Debian-based|
|----------|------------|
|pacman -S ninja xdg-user-dirs gnome-keyring unzip xz-utils zip|apt install ninja-build xdg-user-dirs gnome-keyring unzip xz-utils zip|
Install [Flutter](https://docs.flutter.dev/get-started/install/linux) and [Android SDK tools](https://developer.android.com/studio/command-line/sdkmanager), then try your setup:
2022-09-29 12:08:04 +03:00
```
flutter pub get
# Build .APK for Android
flutter build --flavor production apk
# Build AAB bundle for Google Play
flutter build --flavor production aab
# Build Linux binaries
flutter build linux
# Build Windows binaries
flutter build windows
# Package AppImage
appimage-builder --recipe appimage.yml
# Package Flatpak
flatpak-builder --force-clean --repo=flatpak-repo flatpak-build flatpak.yml
flatpak build-bundle flatpak-repo org.selfprivacy.app.flatpak org.selfprivacy.app
```
## Translations
[![Translation status](http://weblate.selfprivacy.org/widgets/selfprivacy/-/selfprivacy-app/multi-auto.svg)](http://weblate.selfprivacy.org/engage/selfprivacy/)
2022-09-29 12:08:04 +03:00
Translations are stored in `assets/translations/*.json` and can be edited on <https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/>.