mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-07-01 11:31:28 +00:00
Adapt .md files to four spaces for correct lists
For longer lists with various paragraphs per item, (gitlab?) markdown needs four spaces of indentation to work correctly: https://docs.gitlab.com/ee/user/markdown.html#lists Signed-off-by: Michael Pimmer <info@fonfon.at> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Michael Pimmer
James Valleroy
parent
425f7fbd92
commit
b0e09736d0
104
HACKING.md
104
HACKING.md
@ -9,31 +9,31 @@ FreedomBox development rather simple: You can edit the source code on your host
|
||||
and immediately see the effects in the running VM. The entire setup is automatic
|
||||
and requires about 4.5 GB of disk space.
|
||||
|
||||
1. Install Vagrant and VirtualBox:
|
||||
1. Install Vagrant and VirtualBox:
|
||||
|
||||
```
|
||||
$ sudo apt-get install virtualbox vagrant
|
||||
```
|
||||
```
|
||||
$ sudo apt-get install virtualbox vagrant
|
||||
```
|
||||
|
||||
2. To download, setup, run, and configure a VM for FreedomBox development using
|
||||
Vagrant, simply execute in your FreedomBox Service (Plinth) development
|
||||
folder:
|
||||
2. To download, setup, run, and configure a VM for FreedomBox development using
|
||||
Vagrant, simply execute in your FreedomBox Service (Plinth) development
|
||||
folder:
|
||||
|
||||
```
|
||||
$ vagrant up
|
||||
```
|
||||
```
|
||||
$ vagrant up
|
||||
```
|
||||
|
||||
3. To access FreedomBox web interface (from host), visit
|
||||
https://localhost:4430/plinth/
|
||||
3. To access FreedomBox web interface (from host), visit
|
||||
https://localhost:4430/plinth/
|
||||
|
||||
4. Edit the source code in your host machine's FreedomBox Service (Plinth)
|
||||
development folder. By default, this folder is shared within the VM, at
|
||||
`/vagrant/`. To actually reflect the changes in the running VM, run on your
|
||||
host:
|
||||
4. Edit the source code in your host machine's FreedomBox Service (Plinth)
|
||||
development folder. By default, this folder is shared within the VM, at
|
||||
`/vagrant/`. To actually reflect the changes in the running VM, run on your
|
||||
host:
|
||||
|
||||
```
|
||||
$ vagrant provision
|
||||
```
|
||||
```
|
||||
$ vagrant provision
|
||||
```
|
||||
|
||||
## Installing Dependencies
|
||||
|
||||
@ -49,54 +49,54 @@ $ sudo apt install -y $(plinth --list-dependencies)
|
||||
It is recommended that you use Vagrant to setup your development environment.
|
||||
However, for some reason, you wish setup manually, the following tips will help:
|
||||
|
||||
1. Instead of running `setup.py install` after every source modification, run
|
||||
the following command:
|
||||
1. Instead of running `setup.py install` after every source modification, run
|
||||
the following command:
|
||||
|
||||
```
|
||||
$ sudo python3 setup.py develop
|
||||
```
|
||||
```
|
||||
$ sudo python3 setup.py develop
|
||||
```
|
||||
|
||||
This will install the python package in a special development mode. Run it
|
||||
normally. Any updates to the code (and core package data files) do not
|
||||
require re-installation after every modification.
|
||||
This will install the python package in a special development mode. Run it
|
||||
normally. Any updates to the code (and core package data files) do not
|
||||
require re-installation after every modification.
|
||||
|
||||
CherryPy web server also monitors changes to the source files and reloads
|
||||
the server as soon as a file is modified. Hence it is usually sufficient
|
||||
to modify the source and refresh the browser page to see the changes.
|
||||
CherryPy web server also monitors changes to the source files and reloads
|
||||
the server as soon as a file is modified. Hence it is usually sufficient
|
||||
to modify the source and refresh the browser page to see the changes.
|
||||
|
||||
2. FreedomBox Service (Plinth) also supports running without installing (as much
|
||||
as possible). Simply run it as:
|
||||
2. FreedomBox Service (Plinth) also supports running without installing (as much
|
||||
as possible). Simply run it as:
|
||||
|
||||
```
|
||||
$ sudo ./run --debug --develop
|
||||
```
|
||||
```
|
||||
$ sudo ./run --debug --develop
|
||||
```
|
||||
|
||||
In this mode, FreedomBox Service (Plinth) runs in working directory without
|
||||
need for installation. The `plinth.conf` config file and the action
|
||||
scripts of the working directory are used. It creates all that data and
|
||||
runtime files in `data/var/*`.
|
||||
In this mode, FreedomBox Service (Plinth) runs in working directory without
|
||||
need for installation. The `plinth.conf` config file and the action
|
||||
scripts of the working directory are used. It creates all that data and
|
||||
runtime files in `data/var/*`.
|
||||
|
||||
*Note:* This mode is supported only in a limited manner. The following are
|
||||
the unknown issues with it:
|
||||
*Note:* This mode is supported only in a limited manner. The following are
|
||||
the unknown issues with it:
|
||||
|
||||
1. Help pages are also not built. Run `make -C doc` manually.
|
||||
1. Help pages are also not built. Run `make -C doc` manually.
|
||||
|
||||
2. Actions do not work when running as normal user without `sudo` prefix.
|
||||
You need to add `actions` directory to be allowed for `sudo` commands.
|
||||
See `data/etc/sudoers.d/plinth` for a hint.
|
||||
2. Actions do not work when running as normal user without `sudo` prefix.
|
||||
You need to add `actions` directory to be allowed for `sudo` commands.
|
||||
See `data/etc/sudoers.d/plinth` for a hint.
|
||||
|
||||
### Testing Inside a Virtual Machine
|
||||
|
||||
1. Checkout source on the host.
|
||||
1. Checkout source on the host.
|
||||
|
||||
2. Share the source folder and mount it on virtual machine. This could be done
|
||||
over NFS, SSH-fs or 'Shared Folders' feature on VirtualBox.
|
||||
2. Share the source folder and mount it on virtual machine. This could be done
|
||||
over NFS, SSH-fs or 'Shared Folders' feature on VirtualBox.
|
||||
|
||||
3. Run `setup.py develop` or `setup.py install` as described above on guest
|
||||
machine.
|
||||
3. Run `setup.py develop` or `setup.py install` as described above on guest
|
||||
machine.
|
||||
|
||||
4. Access the guest machine's FreedomBox web UI from host after setting bridging
|
||||
or NATing for guest virtual machine.
|
||||
4. Access the guest machine's FreedomBox web UI from host after setting bridging
|
||||
or NATing for guest virtual machine.
|
||||
|
||||
## Running Tests
|
||||
|
||||
|
||||
128
INSTALL.md
128
INSTALL.md
@ -1,65 +1,65 @@
|
||||
# Installing FreedomBox Service (Plinth)
|
||||
|
||||
1. Install the dependencies:
|
||||
1. Install the dependencies:
|
||||
|
||||
On a Debian based system, run:
|
||||
On a Debian based system, run:
|
||||
|
||||
```
|
||||
$ sudo apt-get install \
|
||||
augeas-tools \
|
||||
dblatex \
|
||||
docbook-utils \
|
||||
e2fsprogs \
|
||||
fonts-lato \
|
||||
gettext \
|
||||
gir1.2-glib-2.0 \
|
||||
gir1.2-nm-1.0 \
|
||||
ldapscripts \
|
||||
libjs-bootstrap \
|
||||
libjs-jquery \
|
||||
libjs-modernizr \
|
||||
make \
|
||||
network-manager \
|
||||
ppp \
|
||||
pppoe \
|
||||
python3 \
|
||||
python3-apt \
|
||||
python3-augeas \
|
||||
python3-bootstrapform \
|
||||
python3-cherrypy3 \
|
||||
python3-configobj \
|
||||
python3-coverage \
|
||||
python3-django \
|
||||
python3-django-axes \
|
||||
python3-django-captcha \
|
||||
python3-django-stronghold \
|
||||
python3-gi \
|
||||
python3-psutil \
|
||||
python3-requests \
|
||||
python3-ruamel.yaml \
|
||||
python3-setuptools \
|
||||
xmlto
|
||||
```
|
||||
```
|
||||
$ sudo apt-get install \
|
||||
augeas-tools \
|
||||
dblatex \
|
||||
docbook-utils \
|
||||
e2fsprogs \
|
||||
fonts-lato \
|
||||
gettext \
|
||||
gir1.2-glib-2.0 \
|
||||
gir1.2-nm-1.0 \
|
||||
ldapscripts \
|
||||
libjs-bootstrap \
|
||||
libjs-jquery \
|
||||
libjs-modernizr \
|
||||
make \
|
||||
network-manager \
|
||||
ppp \
|
||||
pppoe \
|
||||
python3 \
|
||||
python3-apt \
|
||||
python3-augeas \
|
||||
python3-bootstrapform \
|
||||
python3-cherrypy3 \
|
||||
python3-configobj \
|
||||
python3-coverage \
|
||||
python3-django \
|
||||
python3-django-axes \
|
||||
python3-django-captcha \
|
||||
python3-django-stronghold \
|
||||
python3-gi \
|
||||
python3-psutil \
|
||||
python3-requests \
|
||||
python3-ruamel.yaml \
|
||||
python3-setuptools \
|
||||
xmlto
|
||||
```
|
||||
|
||||
2. Install FreedomBox Service (Plinth):
|
||||
|
||||
Unzip the source into a directory. Change to the directory containing the
|
||||
program and run:
|
||||
Unzip the source into a directory. Change to the directory containing the
|
||||
program and run:
|
||||
|
||||
```
|
||||
$ sudo python3 setup.py install
|
||||
$ sudo apt install -y $(plinth --list-dependencies)
|
||||
```
|
||||
```
|
||||
$ sudo python3 setup.py install
|
||||
$ sudo apt install -y $(plinth --list-dependencies)
|
||||
```
|
||||
|
||||
3. Run FreedomBox Service (Plinth):
|
||||
3. Run FreedomBox Service (Plinth):
|
||||
|
||||
```
|
||||
$ sudo plinth
|
||||
```
|
||||
```
|
||||
$ sudo plinth
|
||||
```
|
||||
|
||||
4. Access FreedomBox UI:
|
||||
4. Access FreedomBox UI:
|
||||
|
||||
UI should be accessible at http://localhost:8000/plinth
|
||||
UI should be accessible at http://localhost:8000/plinth
|
||||
|
||||
# Note on Django version:
|
||||
|
||||
@ -72,22 +72,22 @@ $ django-admin --version
|
||||
|
||||
If apt-get provided django < 1.11, then follow the steps below:
|
||||
|
||||
1. Uninstall older django versions:
|
||||
1. Uninstall older django versions:
|
||||
|
||||
```
|
||||
$ sudo apt-get remove python3-django python3-django-stronghold \
|
||||
python3-bootstrap
|
||||
```
|
||||
```
|
||||
$ sudo apt-get remove python3-django python3-django-stronghold \
|
||||
python3-bootstrap
|
||||
```
|
||||
|
||||
2. Install Python3 pip:
|
||||
2. Install Python3 pip:
|
||||
|
||||
```
|
||||
$ sudo apt-get install python3-pip
|
||||
```
|
||||
```
|
||||
$ sudo apt-get install python3-pip
|
||||
```
|
||||
|
||||
3. Install django1.11 through pip:
|
||||
3. Install django1.11 through pip:
|
||||
|
||||
```
|
||||
$ sudo pip3 install django django-bootstrap-form django-stronghold \
|
||||
django-axes django-simple-captcha --upgrade
|
||||
```
|
||||
```
|
||||
$ sudo pip3 install django django-bootstrap-form django-stronghold \
|
||||
django-axes django-simple-captcha --upgrade
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user