Skip to content
This repository was archived by the owner on Sep 19, 2023. It is now read-only.

Installation

Jump to bottom
pizzapanther edited this page Apr 30, 2012 · 24 revisions

Installation

Requirements

  1. OpenSSL (sudo apt-get install openssl)
  2. Python Package Installer (Recommended, sudo apt-get install python-pip)
  3. dtach (Recommended for persistent terminals, sudo apt-get install dtach)

Notes on Default Install

For ease of installation, Neutron by default creates a SQLite 3 database and has a built in Tornado Web Server. If you would like to change the default database or any other settings, create a settings_local.py file in the Neutron-IDE/neutron/ directory. You can also install Neutron IDE behind many different web servers. For more information on how to do this, see the Django Deployment Docs. Lastly, Neutron IDE by default will create a SSL certificate for you so all traffic is encrypted.

The default Tornado server starts on two ports, 8000 and 8001. The first port, 8000, is SSL and is how you should interact with the IDE. The second port, 8001, is non-SSL and for external tool requests like for the external image editor. To change these ports add HTTP_PORT and IMG_EDITOR_PORT to your settings_local.py.

Default Install

git clone https://github.com/pizzapanther/Neutron-IDE.git
cd Neutron-IDE
sudo pip install -r requirements.txt
cd neutron
./manage.py syncdb #create a user account when asked
./manage.py migrate
./neutronide.py -l -f start
  1. Visit https://localhost:8000/admin/ (Notice https)
  2. Fill out a user profile for your user under the User section. (Fill out Base directory. This is where you store all your code.)
  3. Visit https://localhost:8000/
  4. Start coding!

Directory Searches

Directory searches require running Celery which processes asynchronous tasks. To start Celery run the following:

./manage.py celeryd

Upgrading from versions less than 12.02.

In version 12.02 the default locations changed for logs, files, and the database. Do the following before following the upgrade instructions.

cd Neutron-IDE
mkdir ~/neutron
mv neutron.sql3 ~/neutron
mv neutron/static/uploads ~/neutron

Upgrade Instructions

cd Neutron-IDE
git pull
pip install -r requirements.txt
cd neutron
./manage.py syncdb
./manage.py migrate
./neutronide.py start

Tracking

In version 11.11 Google Analytics was added to the editor so we can keep a count of how many people use Neutron IDE. If you would like to turn off the tracking, in settings_local.py set IDE_TRACK = False.

Running Neutron on port 80 and 443

Port 80 and 443 are privileged ports so if you want to use Neutron IDE on those ports then you either have to run it as root, which is not recommended, or you can use authbind. Follow the directions below to use authbind with ports 80 and 443.

In settings_local.py set:

HTTP_PORT = 443
IMG_EDITOR_PORT = 80

As root:

touch /etc/authbind/byport/80
chown user:user /etc/authbind/byport/80
chmod 500 /etc/authbind/byport/80
touch /etc/authbind/byport/443
chown user:user /etc/authbind/byport/443
chmod 500 /etc/authbind/byport/443

Copy start_ide.bsh.example to start_ide.bsh. Edit start_ide.bsh as needed.

Clone this wiki locally