40 Commits

Author SHA1 Message Date
Sunil Mohan Adapa
fd345aca80
web_framework: Generate and retain a secret key
- Secret is important for various functions of Django. There is no impact on
existing installations due to the change. Improves the security of existing
functions in minor ways and will be useful in future usage of Django.

- Create the file in /var/lib/plinth/ with 0o600 permissions.

- Make git ignore the file in code folder.

- Don't copy the file during './setup.py install' operation.

Impact to users after upgrade:

- All existing sessions will get logged out. This is because SECRET_KEY is used
to generate user session hash that is used to logout users when their password
changes.

Tests performed:

- Run development version of service. File should get created in
data/var/lib/plinth/django-secret.key. Permissions should be 0o600.

- Run again, the file should not be overwritten. Printing
django.conf.settings.SECRET_KEY should match the one in the file.

- Run `setup.py install`. This should not install django-secret.key in
/var/lib/plinth.

- Run `sudo -u plinth plinth`. This should create the secret key file in
/var/lib/plinth/django-secret.key. Permissions on the file should be 0o600.
Ownership should be plinth:plinth.

- Remove the file in both cases, a fresh new file should get created with new key.

- Truncate the file to less than 128 chars, the existing file should get
overwritten with new key.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-02-24 18:04:20 -05:00
Alice Kile
92d60ab7b4
gitignore: Add .vscode & segregate editor settings
Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>
2020-02-21 20:32:09 +05:30
Sunil Mohan Adapa
80498919fb
doc: Add developer documentation using Sphinx
- This is completely reworked but based on /Developer page in the FreedomBox
  Manual.

- This documentation can be made available as static site on
  https://docs.freedombox.org and the /Developer page in the FreedomBox Manual
  can be dropped.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2019-11-02 13:51:14 -04:00
Joseph Nuthalapati
d62463247f
doc: Move English manual to manual/en directory
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil@medhas.org Have common top level makefile for building manual]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2019-10-30 19:25:02 -04:00
Sunil Mohan Adapa
3be041b28f
backups: Git ignore the .ssh folder in data folder
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
2019-07-03 12:45:06 +05:30
Sunil Mohan Adapa
fd9b6770be
tests: Use pytest for running all tests
- Create option --include-functional to run functional tests. Otherwise, they
  are disabled by default. If pytest-bdd is not installed, functional tests are
  not discovered at all.

- Make pytest-django discover the setting files by creating dummy manage.py in
  top level directory.

- Make pytest run as './setup.py pytest'. Add alias from './setup.py test'. This
  requires pytest-runner package.

- Merge .gitignore files from functional_tests/

- Update gitlab-ci.yml to run tests with coverage using pytest.

- Update HACKING.md to suggest using py.test-3 instead of old way of running.
  Merge functional tests README.md into HACKING.md.

- Remove execution wrapper runtests.py as pytest-django is able to configure
  Django settings before execution of tests. Update tests to explicitly ask for
  Django database as database access is denied by default.

- Replace usage of python3-coverage with python3-pytest-coverage. Execution
  wrappers are not required.

- Add build dependencies on pytest modules.

- Let all warnings be shown after running tests.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2019-03-10 09:54:23 -04:00
Sunil Mohan Adapa
5f8965df25
debian: Rename plinth package to freedombox
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2018-12-31 15:59:08 -05:00
Sunil Mohan Adapa
d40ef19a25
debian: Fix lintian warning about vcs ignore file
W: plinth: package-contains-vcs-control-file
usr/lib/python3/dist-packages/plinth/tests/.gitignore

Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2018-12-31 15:58:49 -05:00
Sunil Mohan Adapa
db8ec9e784
debian: Ignore debian/debhelper-build-stamp
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2018-12-31 15:58:44 -05:00
Joseph Nuthalapati
5e06017e5c
customization: Serve custom shortcuts through the REST API
Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2018-10-08 20:30:24 -04:00
James Valleroy
b99c8ed950
Ignore temp xml manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2018-03-26 20:18:35 -04:00
Sunil Mohan Adapa
62d103bc66
git: Ignore debian generated temporary files
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2017-11-04 15:30:25 -04:00
Joseph Nuthalpati
5ad180fcc9
Add Tahoe-LAFS module
- Created basic plinth app which starts an introducer and a storage
  node on the FreedomBox.
- Prompt user to set a domain name before creating Tahoe-LAFS nodes.
- Support adding and removing of introducers to the storage node.
- Serve Tahoe-LAFS from a different port.
- Start all nodes and introducers at system startup.
- Add utility class YAMLFile with test cases.
2017-06-10 09:38:57 -04:00
Joseph Nuthalpati
995365f3df
Add SSO using auth_pubtkt for 3 web apps
- Install mod_auth_pubtkt and generate public/private key-pair.

- Redirect user to login page if no cookie is presented.

- Add check for authenticated user for login page.

- Temporarily switched to DSA because of a bug in mod_auth_pubtkt
  which causes it to accept only DSA and not RSA. Also had to use SHA1
  instead of SHA256.

- Enabled SSO for Syncthing, Repro and TT-RSS.

- Using tokens to authorize by user groups.

- Generate keys during first boot.
2017-06-03 10:29:42 -04:00
Sunil Mohan Adapa
dd5ab7612e
Minor refactoring and lint fixes
- Rename AdminMiddleware to AdminRequiredMiddleware to be consistent
  with stronghold/Django terminology

- Simplify .gitignore pattern

- Format single line docstrings as per PEP8.

- Add missing docstrings.

- Restrict lines to 79 characters.
2017-02-15 21:07:27 +05:30
lispyclouds
da2a63bd96
Add intellij and macos file to gitignore 2017-02-15 21:04:56 +05:30
James Valleroy
eed0babb13
Add Vagrantfile. 2016-08-03 19:54:12 +05:30
Sunil Mohan Adapa
6483732fa2 Ignore the compiled message files 2015-11-13 22:44:00 +05:30
Sunil Mohan Adapa
24a67991ee doc: Stop ignoring removed files 2015-09-27 09:49:45 -04:00
Sunil Mohan Adapa
af0d7285ca doc: Remove TODO file favoring central list
The generated TODO file is very limted in scope and gives a wrong
impression to a potential contributor.  We have worked towards a central
TODO list for the entire project scrapping all other TODO lists.
Redirect the contributor to that list.
2015-09-27 09:49:44 -04:00
Bob Girard
a502da63d5 Add test coverage measurement and reporting
- Implement coverage functionality as a setuptools Command subclass
  (in plinth/tests/coverage/test_coverage.py)
- Register the new 'test_coverage' command in setup.py
- Modify the INSTALL file to specify python3-coverage as a new dependency
- Modify the HACKING file to document the new 'test_coverage' command
- Have git (via .gitignore) ignore the '.coverage' output data file and
  the contents of the 'plinth/tests/coverage/report' directory
2014-12-06 18:14:42 +05:30
Sunil Mohan Adapa
f243dfa3ab Allow running from working directory 2014-08-31 16:32:11 +05:30
Sunil Mohan Adapa
5ed58d6632 Rename plinth.sample.config to plinth.config 2014-08-31 13:05:21 +05:30
Sunil Mohan Adapa
cee3c3a416 Ignore python dist and egg-info directories 2014-08-29 20:23:58 +05:30
fonfon
d4d6948eb9 when running plinth with default server_dir '/' some static files and redirects were wrong -- fixed that; 2014-07-09 00:58:20 +00:00
Sunil Mohan Adapa
cff0f1bdf6 Use Django auth framework instead of custom one
- Store users using Django user/group/permission model
- Database is data/plinth.sqlite3 instead of data/user.sqlite3
- Use Django auth context processors in templates
2014-06-28 13:11:34 +02:00
Sunil Mohan Adapa
fc37293ac6 Update .gitignore 2014-06-21 11:44:43 +02:00
Sunil Mohan Adapa
882392f104 Dont gitignore compiled template files 2014-05-04 16:09:35 +05:30
Sunil Mohan Adapa
c3a8f3cb61 Ignore .py.bak files created when compiling templates 2014-04-05 14:22:28 +09:00
Nick Daly
1da32164e5 Ignore plinth.config.
How'd we go so long without that??
2013-10-27 10:51:08 -05:00
Nick Daly
3ab7d05bf3 Add hosting and auto-archive-creation.
The makefile has three new targets:

1. hosting: Publish repository and automagically build the archives to
   serve to clients.

2. current-checkout.tar.gz: Create an archive of the current project
   directory.

3. current-repository.tar.gz: Create an archive of the current project
   directory along with the source repository metadata so that the
   archive is a full checkout of the project.
2013-04-23 21:44:09 -05:00
Nick Daly
f55c7a48ea Merged with James's upstream.
Hope I did it right.  If I screwed up, withsqlite is borked.
2013-04-23 17:49:22 -05:00
James Vasile
5612316128 don't track backup text files, don't worry about cherrypy.config 2013-02-09 13:29:45 -05:00
James Vasile
8f5dd5ea5c track cfg.py 2013-02-06 16:15:31 -05:00
Tom Galloway
646b5518bb withsqlite is now retrieved from github. Manage User & Groups pages now display correctly but don't do anything yet. 2013-01-16 13:08:48 +00:00
Tom Galloway
b2c157ec1d Added predepend packages and updated python path for build folders. 2013-01-03 15:08:06 +00:00
bnewbold
7c9cb6ccb9 update .gitignore 2012-07-26 12:53:42 -07:00
James Vasile
37d8e3d01c ignore backups 2012-02-19 15:07:15 -05:00
James Vasile
758355da0d Ignore backup files that start with \# 2011-09-29 23:41:59 -04:00
James Vasile
35071d7212 ... 2011-02-22 13:32:45 -05:00