Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Merge branch 'master' into feature/ingredient-images

Roland Geider7037ac9d8be1
diff --cc docs/commands.rst
index 8f0f3b6d0,000000000..11cb5cf20
mode 100644,000000..100644
--- a/docs/commands.rst
+++ b/docs/commands.rst
@@@ -1,300 -1,0 +1,301 @@@
+Commands
+========
+
+Please note that the administration commands are intended e.g. to bootstrap/install
+an application to a new system, while the management ones are made to administer a
+running application (to e.g. delete guest users, send emails, etc.).
+
+Administration Commands
+-----------------------
+
+The application provides several administration and bootstrapping commands that
+can be passed to the ``wger`` command::
+
+ wger <command>
+
+
+You can get a list of all available commands by calling ``wger`` without any
+arguments::
+
+ Available tasks:
+
+ bootstrap Performs all steps necessary to bootstrap the application
+ config-location Returns the default location for the settings file and the data folder
+ create-or-reset-admin Creates an admin user or resets the password for an existing one
+ create-settings Creates a local settings file
+ load-fixtures Loads all fixtures
+ load-online-fixtures Downloads fixtures from server and installs them (at the moment only ingredients)
+ migrate-db Run all database migrations
+ start Start the application using django's built-in webserver
+
+You can also get help on a specific command with ``wger --help <command>``.
+
+.. note::
+ Most commands support a ``--settings-path`` command line option that sets the
+ settings file to use for the operation. If you use it, it is recommended to
+ use absolute paths, for example::
+
+ wger bootstrap --settings-path /path/to/development/wger/settings-test.py
+
+
+
+Bootstrap
+~~~~~~~~~
+
+Command: **bootstrap**
+
+This command bootstraps the application: it creates a settings file, initialises
+a SQLite database, loads all necessary fixtures for the application to work and
+creates a default administrator user. While it can also work with e.g. a PostgreSQL
+database, you will need to create it yourself::
+
+ wger bootstrap
+
+The most usual use-case is creating the settings file and the SQLite database to
+their default locations, but you can set your own paths if you want e.g. start
+developing on a branch that is going to change the database schema.
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] bootstrap [--options] [other tasks here ...]
+
+ Docstring:
+ Performs all steps necessary to bootstrap the application
+
+ Options:
+ -a STRING, --address=STRING Address to use. Default: localhost
+ -b, --browser Whether to open the application in a browser window. Default: false
+ -d STRING, --database-path=STRING Path to SQLite database (absolute path recommended). Leave empty for default
+ -p, --port Port to use. Default: 8000
+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default
+
+
+Start wger
+~~~~~~~~~~
+
+Command: **start**
+
+Starts an already installed application::
+
+ wger start
+
+Please note that this is simply a comfort function and does not use any *magic*,
+it simply calls Django's development server and (optionally) opens a browser
+window. If you are developing, using the usual ``python manage.py runserver``
+is probably better.
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] start [--options] [other tasks here ...]
+
+ Docstring:
+ Start the application using django's built in webserver
+
+ Options:
+ -a STRING, --address=STRING Address to bind to. Default: localhost
+ -b, --browser Whether to open the application in a browser window. Default: false
+ -e STRING, --extra-args=STRING Additional arguments to pass to the builtin server. Pass as string: "--arg1 --arg2=value". Default: none
+ -p, --port Port to use. Default: 8000
+ -s STRING, --settings-path=STRING Path to settings file. Leave empty for default
+ -t, --[no-]start-server Whether to start the development server. Default: true
+
+
+Default locations
+~~~~~~~~~~~~~~~~~
+
+Command: **config-location**
+
+Information command that simply outputs the default locations for the settings
+file as well as the data folder used for the SQLite database and the uploaded
+files.
+
+
+Create settings
+~~~~~~~~~~~~~~~
+
+Command: **create-settings**
+
+Creates a new settings file-based. If you call it without further arguments it
+will create the settings in the default locations::
+
+ wger create-settings
+
+If you pass custom paths, it's recommended to use absolute paths::
+
+ wger create-settings --settings-path /path/to/development/wger/settings-test.py --database-path /path/to/development/wger/database-test.sqlite
+
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] create-settings [--options] [other tasks here ...]
+
+ Docstring:
+ Creates a local settings file
+
+ Options:
+ -a STRING, --database-type=STRING Database type to use. Supported: SQLite3, postgresql. Default: SQLite3
+ -d STRING, --database-path=STRING Path to SQLite database (absolute path recommended). Leave empty for default
+ -k, --key-length Lenght of the generated secret key. Default: 50
+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default
+ -u STRING, --url=STRING
+
+
+
+Create or reset admin
+~~~~~~~~~~~~~~~~~~~~~
+
+Command: **create-or-reset-admin**
+
+Makes sure that the default administrator user exists. If you change the password,
+it is reset.
+
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] create-or-reset-admin [--options] [other tasks here ...]
+
+ Docstring:
+ Creates an admin user or resets the password for an existing one
+
+ Options:
+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default
+
+
+
+Migrate database
+~~~~~~~~~~~~~~~~
+
+Command: **migrate-db**
+
+Migrates the database schema. This command is called internally when installing
+the application. The only need to call this explicitly is after installing a new
+version of the application.
+
+Calling this command is a safe operation, if your database is current, nothing
+will happen.
+
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] migrate-db [--options] [other tasks here ...]
+
+ Docstring:
+ Run all database migrations
+
+ Options:
+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default
+
+
+
+Load fixtures
+~~~~~~~~~~~~~
+
+Command: **load-fixtures**
+
+Loads all fixture files with the default data. This data includes all data necessary
+for the application to work such as:
+
+* exercises, muscles, equipment
+* ingredients, units
+* languages
+* permission groups
+* etc.
+
+Note that ingredients are not included and need to be installed separately with
+download-online-fixtures.
+
+This command is called internally when installing the application but you can use
+it to reset the data to the original state. Note: new entries or user entries such
+as workouts are *not* reset with this, only the application data.
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] load-fixtures [--options] [other tasks here ...]
+
+ Docstring:
+ Loads all fixtures
+
+ Options:
+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default
+
+
+Load online fixtures
+~~~~~~~~~~~~~~~~~~~~
+
+Command: **load-online-fixtures**
+
+Downloads ingredient and weight units fixtures and installs them. They are not
+included in the repository due to size.
+
+This command is called internally when installing the application but you can use
+it to reset the data to the original state. Note: new entries or user entries such
+as workouts are *not* reset with this, only the application data.
+
+Usage::
+
+ Usage: inv[oke] [--core-opts] load-online-fixtures [--options] [other tasks here ...]
+
+ Docstring:
+ Downloads fixtures from server and installs them (at the moment only ingredients)
+
+ Options:
+ -s STRING, --settings-path=STRING Path to settings file (absolute path). Leave empty for default
+
+
+Management commands
+-------------------
+
+wger also implements a series of Django commands that perform different
+management functions that are sometimes needed. Call them with
+``python manage.py <command_name>``:
+
+**download-exercise-images**
- synchronizes the exercise images from wger.de to the local installation.
-
++ synchronizes the exercise images from wger.de to the local installation. Read
++ its help text as it could save the wrong image to the wrong exercise should
++ different IDs match.
+**download-ingredient-images**
+ synchronizes the ingredient images from wger.de to the local installation.
+
+**redo-capitalize-names**
+ re-calculates the capitalized exercise names. This command can be called if the
+ current "smart" capitalization algorithm is changed. This is a safe operation
+ since the original names (as entered by the user) are still available.
+
+**submitted-exercises**
+ simply prints a list of user-submitted exercises
+
+**extract-i18n**
+ extract strings from the database that have to be inserted manually in the PO
+ file when translating. These include e.g. exercise categories.
+
+**clear-cache**
+ clears different application caches. Might be needed after some updates or
+ just useful while testing. Please note that you must select what caches to
+ clear.
+
+**update-user-cache**
+ update the user cache-table. This command is only needed when the python code
+ used to calculate any of the cached entries is changed and the ones in the
+ database need to be updated to reflect the new logic.
+
+
+
+Cron
+~~~~
+
+The following commands are built to be called regularly, via a cronjob or
+similar
+
+**delete-temp-users**
+ deletes all guest users older than 1 week. At the moment this value can't be
+ configured
+
+**email-reminders**
+ sends out email reminders for a user that need to create a new workout.
+
+**email-weight-reminders**
+ sends out email reminders for a user that need to enter a new (body) weight entry.
+
+**inactive-members**
+ Sends email for gym members that have not been to the gym for a specified
+ amount of weeks.
diff --cc docs/settings.rst
index 6d4502f8a,000000000..170a869b9
mode 100644,000000..100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@@ -1,41 -1,0 +1,40 @@@
+.. _settings:
+
+Settings
+========
+
+You can configure some of the application behaviour with the ``WGER_SETTINGS``
+dictionary in your settings file. Currently, the following options are supported:
+
+**ALLOW_REGISTRATION**: Default ``True``.
+ Controls whether users can register on their own or if a gym administrator has
+ to create the user accounts.
+
+**ALLOW_GUEST_USERS**: Default ``True``.
+ Controls whether users can use the site as a guest user or if an administrator
+ has to create the user accounts, as with the option above.
+
+**USE_RECAPTCHA**: Default ``False``.
+ Controls whether a captcha challenge will be presented when new users register.
+
+**REMOVE_WHITESPACE**: Default ``False``.
+ Removes whitespaces around HTML tags to reduce the size of the resulting HTML.
+ If you are not serving the site using TLS you probably want to use the GZip
+ middleware instead. Read the Django documentation on the security implications
+ (BREACH attack).
+
+**EMAIL_FROM**: Default `wger Workout Manager <[email protected]>`
+ The sender address used for sent emails by the system such as weight reminders
+
+**DOWNLOAD_FROM_OFF**: Default false. Whether to download missing ingredient
+ images from Open Food Facts. Please do not set to true. To download available
+ images, use the `download-ingredient-images` command, which downloads them
+ from a selected wger instance.
+
-
+.. note::
+ If you want to override a default setting, don't overwrite all the dictionary
+ but only the keys you need, e.g. ``WGER_SETTINGS['foo'] = 'bar'``. This avoids
+ problems when new keys are added in the global settings.
+
+Set the URL for your site in the table ``django_site``. This is only used e.g. in
+the password reset emails.
diff --cc wger/settings_global.py
index aed8b58af,f566d7fff..2d0ccca07
--- a/wger/settings_global.py
+++ b/wger/settings_global.py
@@@ -437,10 -428,7 +429,11 @@@ WGER_SETTINGS =
'REMOVE_WHITESPACE': False,
'ALLOW_REGISTRATION': True,
'ALLOW_GUEST_USERS': True,
+ 'ALLOW_UPLOAD_VIDEOS': False,
'EMAIL_FROM': 'wger Workout Manager <[email protected]>',
- 'TWITTER': False
+ 'TWITTER': False,
+ 'DOWNLOAD_FROM_OFF': False
}
+
+# Whether the application is being run regularly or during tests
+TESTING = len(sys.argv) > 1 and sys.argv[1] == 'test'