jasima/majuna

Fork 0

The legacy monolithic portal application. It is not recommended that new deployments use this code and it is retained here only for its historical value.

Find a file

Ana Custura 3922082a56 feat: remove sudo from installed packages		2024-12-04 16:14:20 +00:00
app	feat: add prometheus flask metrics	2024-12-04 16:14:20 +00:00
docs	docs: some reorganisation of documentation	2024-12-02 00:29:45 +00:00
migrations	refactor: moving more models to mapped_column	2024-11-10 15:13:29 +00:00
schemas	docs: some reorganisation of documentation	2024-12-02 00:29:45 +00:00
scripts	feat: create new onion services via api	2024-12-02 00:29:45 +00:00
terraform-modules	deps: update tf module pins	2024-11-09 13:53:42 +00:00
tests	feat(proxy): rewrite the meta module to support hot spares	2023-05-30 16:38:00 +01:00
.gitignore	docs: some reorganisation of documentation	2024-12-02 00:29:45 +00:00
.gitlab-ci.yml	ci: install docs requirements from file	2024-12-02 12:32:05 +00:00
.gitmodules	feat(static): adds new static origins feature	2023-05-25 15:32:31 +01:00
.pylintrc	ci: remove pylint plugin for sqlalchemy	2024-11-16 13:17:27 +00:00
config.yaml.example	docs: update new options for config in the example file	2024-12-02 18:56:21 +00:00
Dockerfile	feat: remove sudo from installed packages	2024-12-04 16:14:20 +00:00
Makefile	feat: upgrade python version and install frontend in container	2024-11-09 17:12:34 +00:00
mypy.ini	lots of typing fixes	2022-05-16 11:44:03 +01:00
README.md	docs: update new options for config in the example file	2024-12-02 18:56:21 +00:00
requirements-docs.txt	docs: some reorganisation of documentation	2024-12-02 00:29:45 +00:00
requirements-types.txt	ci: re-add types-requests	2024-11-10 13:39:08 +00:00
requirements.txt	feat: add prometheus flask metrics	2024-12-04 16:14:20 +00:00
run_waitress.py	feat: move from gunicorn to waitress	2024-12-04 16:14:01 +00:00
setup.cfg	lint: tidying up code in block tasks	2022-06-17 12:42:42 +01:00

README.md

Bypass Censorship Portal

Self-service deployment of censorship circumvention resources.

Development Setup

For development, it is possible to use SQLite and a single host.

Create and activate a Python virtual environment:

python3 -m venv venv
source ./venv/bin/activate

Install the Python packages needed by the application:

pip install -r requirements.txt
pip install psycopg2-binary

Set up the database:

flask db init
flask db upgrade

Before the application can be run, it will need to be configured. Run cp config.yaml.example config.yaml, then edit config.yaml accordingly. Note that at least one cloud provider must be configured for the application to start successfully. To run the application:

flask run --host=0.0.0.0 --port=5000

New frontend

To build the new portal frontend:

make install-frontend

Copyright

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.