Merge branch 'master' of https://github.com/pluja/Parasitter

2020-07-15 03:03:47 +02:00 · 2020-07-15 03:03:47 +02:00 · 85133e6d47
commit 85133e6d47
parent cda0b18c10 aa864f02d9
2 changed files with 57 additions and 9 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,5 +1,6 @@
 # v0.1.0a
 * BIG efficiency improvements making Parasitter much more cool to use.
+* Improved user search

 # v0.0.2a
 * Efficiency improvements
--- a/README.md
+++ b/README.md
@ -2,16 +2,21 @@
 <p align="center"> <img width="150" src="app/static/img/logo.png"> </img></p> 
 <p align="center"> Twitter via RSS with privacy </p>
 <br>
-Parasitter allows you to follow your favourite twitters without Twitter even knowing it. Parasitter uses Nitter's rss feed in order to gather the latest tweets from your favourite accounts and builds a *twitter-like* feed so you can read them. We will never connect you to Twitter so your privacy is safe when using Parasitter. Parasitter is written in Python and Flask and uses Semantic-UI as its CSS framework.
+
+Parasitter allows you to follow your favorite Twitter accounts with full privacy. Parasitter uses [Nitter's](https://nitter.net/) rss feed in order to gather the latest tweets from your favourite accounts and builds a *twitter-like* feed so you can read them. We will never connect you to Twitter so your privacy is safe when using Parasitter. Parasitter is written in Python and Flask and uses Semantic-UI as its CSS framework.
+
+Parasitter doesn't try to compete with Nitter. It is a complement of it, as it beneficiates from it. Parasitter is not a Twitter viewer as Nitter is. Main difference between Parasitter and Nitter, apart from UI, is that Parasitter allows you to follow users, save Tweets and set up some configuration for your feed. 
+
+Parasitter is possible thanks to several open-source projects that are listed on the [Powered by](#powered-by) section. Make sure to check out those awesome projects!

 ## Index:
 * [Features](#features)
 * [Security](#security)
 * [Privacy](#privacy)
 * [Self hosting](#self-hosting)
-    * [Install](#install)
+    * [Local](#local)
    * [Update](#updating-to-new-versions)
-    * [External access](#external-access)
+    * [Server](#server)
 * [Powered by](#powered-by)

 ## Features:
@ -19,7 +24,7 @@ Parasitter allows you to follow your favourite twitters without Twitter even kno
 * 0 connections to Twitter.
 * Uses RSS feeds (could be expanded to more social networks)
 * Follow Twitter accounts.
-* Save your favourite Tweets.
+* Save your favourite Tweets. (Coming soon)
 * Tor-friendly.
 * Terminal-friendly.
 * Easy 1 minute self-hosting deploy.
@ -43,7 +48,9 @@ It is always recommended to set up a self-hosted instance. It is quite easy and

 # Self hosting

-## Install
+### Local
+You don't need a server to run Parasitter. You can run it on your computer locally and own your (little) data. The installation process is done on a GNU/Linux environment, but should be pretty similar on other platforms.
+
 1. Install `python3`, `pip3` and `git`.
 2. Clone this repository:
    - `git clone https://github.com/pluja/Parasitter.git`
@ -57,10 +64,10 @@ It is always recommended to set up a self-hosted instance. It is quite easy and
    - `source venv/bin/activate`
    > Now you are inside of the virtual environment for python. All instructions wiht [env] indicate that must be done inside the env if you decided to create one. From now on, you will always need to start the application from within the virtual env.
 5. [env] Update pip
-    - `pip install --upgrade pip`
+    - `pip3 install --upgrade pip`
 6. [env] Install the required libraries:
    - `pip3 install -r requirements.txt`
-       > It may require you to use `sudo` or `--user`
+       > Use `sudo` or, preferably `--user`, if not working.
 7. [env] Initialize and prepare the database.
    - `flask db init`
    - `flask db migrate`
@ -80,11 +87,51 @@ It is always recommended to set up a self-hosted instance. It is quite easy and
   > It may be that there are no new packages to install. In that case, all requirements will be satisfied.
 5. Done! You are on latest version.

-### External access:
-> Coming soon..
+### Server
+Another option is to host a Parasitter server so you can access it from anywhere or give access to your beloved friends/community. Installation is a little bit more complex than the [local](#local), but should be easy if you follow the steps.
+
+> WARNING: This section is under construction.
+##### Installing the app:
+1. Install base dependencies:
+   - `sudo apt-get -y update`
+   - `sudo apt-get -y install python3 python3-venv python3-dev`
+   - `sudo apt-get -y install mysql-server postfix supervisor nginx git`
+   > Installation of MySQL will require you to enter a *database root* password.
+2. Install the application:
+   - `git clone https://github.com/pluja/Parasitter.git`
+   - `cd Parasitter`
+3. Prepare the environment:
+   - `python3 -m venv venv`
+   - `source venv/bin/activate`
+   - (venv) $ `pip install -r requirements.txt`
+4. Install deployment packages:
+   - (venv) `pip install gunicorn pymysql`
+5. Edit the *.env* SECRET_KEY:
+   - `nano .env`
+   > This will open an editor. Make sure to change the SECRET_KEY to a string of your like. Make it random and long enough.
+6. Set up FLASK_APP environment variable:
+   - `echo "export FLASK_APP=parasitter.py" >> ~/.profile`
+
+##### Database configuration:
+1. Enter the MySQL command prompt:
+   - `mysql -u root -p`
+   > It will prompt for the "root" password. This password is the one you set on the MySQL installation.
+2. Create the database:
+   - mysql> `create database parasitter character set utf8 collate utf8_bin;`
+   - mysql> `create user 'parasitter'@'localhost' identified by '<db-password>';`
+   > Replace `<db-password>` as the password for the database *parasitter* user. This one needs to match the password set on the DATABASE_URL in the *.env* file (See Step 5 of [App installation](installing-the-app))
+   - mysql> `grant all privileges on parasitter.* to 'parasitter'@'localhost';`
+   - mysql> `flush privileges;`
+   - mysql> `quit;`
+3. Upgrade the database:
+   - (venv) `flask db upgrade`
+
+#### TO BE CONTINUED!

 ### Powered by:
 * [Nitter](https://nitter.net)
 * [Flask](https://flask.palletsprojects.com/)
 * [SQLAlchemy](https://docs.sqlalchemy.org/en/13/)
 * [Semantic-UI](https://semantic-ui.com)
+* [requests-futures](https://github.com/ross/requests-futures)
+* [microblog](https://github.com/miguelgrinberg/microblog)