SweetTooth-Web

SweetTooth-Web is a Django-powered web application that, in co-operation with some GNOME Shell integration helper (deprecated NPAPI plugin or Browser extension) allows users to install, upgrade and enable/disable their own Shell Extensions. All operations with the Shell are done through a special helper which proxies over to the Shell by DBus. Please note that NPAPI plugin is deprecated and was removed from GNOME Shell codebase.

Since extensions can be dangerous, all extensions uploaded to the repository must go through code review and testing.

Requirements

System Requirements:

• python 3.6+
• xapian (xapian-core and xapian-bindings)

Python Requirements:

• django
• django-autoslug
• django-registration
• pillow
• Pygments

Running with Docker

Make sure you have both Docker and Docker Compose installed as well as runnning Docker instance.

You can start website with commands:

$ git clone https://gitlab.gnome.org/Infrastructure/extensions-web.git
$ cd extensions-web/openshift/docker
$ MYSQL_USER=extensions-web \
  MYSQL_PASSWORD=SOME_PASSWORD \
  EGO_ALLOWED_HOST=* \
  EGO_DATABASE_URL=mysql://extensions-web:SOME_PASSWORD@db/extensions-web \
  EGO_NODE_ADDRESS=extensions-web \
  EGO_SECRET_KEY=SOME_SECRET_KEY \
  EGO_XAPIAN_DB=/extensions-web/data/xapian.db \
  docker-compose up --build

That's all! Website will be available as http://localhost:8080.

Don't forget to substitute "SOME_PASSWORD" and "SOME_SECRET_KEY" with proper values.

You also may want to create superuser account - look to virtualenv guide below for apropriate command and Docker documentation for a way running command within running Docker container.

Running with virtualenv

You can get started developing the website with:

$ git clone https://gitlab.gnome.org/Infrastructure/extensions-web.git
$ cd extensions-web
$ virtualenv --system-site-packages ./venv

I use --system-site-packages because we require Xapian, which doesn't have its Python bindings in PyPI.

$ . ./venv/bin/activate
$ pip install -r ../requirements.txt

This will get all the needed PyPi packages in our virtual environment.

Create file "local_settings.py" (in the project root folder) and add the following settings:

SECRET_KEY = 'super-random-secret-passphrase'
ALLOWED_HOSTS = ['*']
DEBUG = True

Once you've done that, proceed with the database migrations:

$ python manage.py migrate
$ python manage.py compilemessages
$ python manage.py createsuperuser --username=joe --email=joe@email.com

After above steps your database should be initialized and almost ready to run.

You should manually specify your site's domain with SQL update:

UPDATE `django_site`
SET `domain` = 'your.domain.name',
    `name` = 'your.domain.name'
WHERE `django_site`.`id` = 1;

And to start the webserver:

$ python manage.py runserver

Log in using superuser account. You should be able to upload and review extensions.

Testing with the Shell

If you have GNOME Shell, and you want to test the installation system, you're going to have to hack your system. For security reasons, the browser plugin and GNOME Shell both ping the URL https://extensions.gnome.org directly. The easiest way to get around this is to make a development environment with the proper things that it needs. Since the Django development server doesn't natively support SSL connections, we need to install Apache. Follow the instructions above to get a proper SweetTooth checkout, and then:

# Install Apache
$ sudo yum install httpd mod_wsgi mod_ssl

# Generate a self-signed cert
$ openssl req -new -nodes -out ego.csr -keyout extensions.gnome.org.key
# Answer questions. The only one required is the Common Name. You must put
# extensions.gnome.org -- the hostname -- as the answer.

$ openssl x509 -req -in ego.csr -signkey extensions.gnome.org.key -out extensions.gnome.org.crt
$ rm ego.csr
$ chmod 600 extensions.gnome.org.key

# Install it on your system.
$ sudo cp extensions.gnome.org.crt /etc/pki/tls/certs/
$ sudo cp --preserve=mode extensions.gnome.org.key /etc/pki/tls/private/

# The shell will look for a special file called 'extensions.gnome.org.crt',
# for development purposes. Otherwise it will use your system's CA bundle.
$ mkdir -p ~/.local/share/gnome-shell
$ cp extensions.gnome.org.crt ~/.local/share/gnome-shell/

# Configure Apache.
$ cp etc/sweettooth.wsgi.example ./sweettooth.wsgi
$ $EDITOR ./sweettooth.wsgi

$ cp etc/sweettooth.httpd.conf.example ./sweettooth.httpd.conf
$ $EDITOR ./sweettooth.httpd.conf
$ sudo cp sweettooth.httpd.conf /etc/httpd/conf.d/sweettooth.conf

# Edit /etc/hosts
$ sudo tee -a /etc/hosts <<< 'extensions.gnome.org 127.0.0.1'