Skip to content
A Flask based content server for the Privly extensions.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
pyvly
tests
.gitignore
.gitmodules
LICENSE
README.md
config.py.dist
manage.py
requirements.txt

README.md

About

Privly is a developing set of browser extensions for protecting content wherever it is posted on the internet. It allows users to view content on any website, without the host site being able to read the content. This content server is meant to store content for users with a Privly extension, but it also provides support for extension-less operation using the Privly Applications.

For more information on what Privly is, read about us.

Development Status

Alpha

For information about our development path, please see the central wiki.

The Privly Flask content server is currently maintained by Garrett Seward, on behalf of the Privly Foundation.

About this Content Server

This server currently supports:

  • All the applications found in the Privly Applications repository.
  • Serialized JSON storage for any text content.

Server API

Read about the API.

Development Server Installation

Prerequisites:

  • Python 2.X
  • To check what version of Python you are running, type python --version in your terminal
  • Pip
  • Virtualenv

These shell commands step through a standard installation.

# Clone this repository and the privly-applications repository.
# The `--recursive` flag ensures you get the privly-applications
# repository.
git clone --recursive https://github.com/privly/privly-flask.git
cd privly-flask

# Create a virtualenv and install requirements
virtualenv env/pyvly
source env/pyvly/bin/activate
pip install -r requirements.txt

# You need to setup config. For a development install you should use
# since you will not need to setup MySQL.
cp config.py.dist config.py
vim config.py # or use the editor of your choice on the config 

# Install depedencies and run
python manage.py init_db # Creates the database
python manage.py seed_db # Seed the database [optional]
python manage.py runserver # Starts the server

Testing the Server

From the projects root directory, run:

    nosetests

Managing Users

The seed command (run with python manage.py seed_db) will create several users for you in development, including: admin@priv.ly, demonstration@priv.ly, development@priv.ly. All these accounts have the same password, password.

Testing/Submitting Bugs

If you have discovered a bug, only open a public issue on GitHub if it could not possibly be a security related bug. If the bug affects the security of the system, please report it privately at privly.org. If it is an urgent issue, please email privly@privly.org. We will then fix the bug and follow a process of responsible disclosure.

Developer Documentation

Discussion of system concepts and high level processes are found in the central wiki.

Resources

Foundation Home
Privly Project Repository List
Development Mailing List
Testing Mailing List
Announcement Mailing List
Central Wiki
Submit a Bug
IRC
Production Content Server
Development Content Server
Download Extension

Contacts

Email:
Community [the 'at' sign] privly.org

Mail:
Privly
PO Box 79
Corvallis, OR 97339

IRC:
Contact the Nick "spectralsun" or "smcgregor" on irc.freenode.net #privly

Issue:
If you open an issue on this repository, you'll get someone's attention.

You can’t perform that action at this time.