From 4d77be2721dc36de6e15a5b9e3008f6e256ad542 Mon Sep 17 00:00:00 2001 From: Dirk Alders Date: Wed, 16 Oct 2024 07:09:34 +0200 Subject: [PATCH] Instructions moved to piki website --- README.md | 62 +------------------------------------------------------ 1 file changed, 1 insertion(+), 61 deletions(-) diff --git a/README.md b/README.md index 1f5a5e8..66692ef 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,2 @@ # piki - -Piki is a minimal wiki. - - -## Installation -### Get the repository -####Go to the subfolder, where you want to create your new Piki-Application (here ~/tmp) - cd ~/tmp -#### Clone the repository - git clone https://git.mount-mockery.de/application/piki.git -#### Change to your repository and initialise it completely - cd piki - git submodule init - git submodule update - - -### Create your virtual environment -#### Create python3 environment - python3 -m venv venv -#### Activate the environment - source venv/bin/activate -#### Install PaTT Requirements - pip install -r requirements.txt - -## Configuration and Initialisation of Piki -### Create your config File -#### Copy the config example - cp config_example/config.py . - chmod 700 config.py - -#### Set a secret key -Edit config.py and add a SECRET_KEY. Generate the secret e.g by executing the following command: - - python manage.py - -At the End of the error message you'll see a random secret: - -KeyError: "You need to create a config.py file including at least a SECRET_KEY definition (e.g.: --> **'HERE IS THE RANDOM SECRET ;-)'** <--)." - - - -### Create your initial database and first user for Patt - python manage.py migrate - python manage.py createsuperuser - -### Finalise Configuration -Now there are two ways to finalise your configuration. The first way is for a test or development system. The other is for a production System. - -1. **Test or development System:** Edit config.py and set the Variable DEBUG to True. - -2. **Production System:** Edit config.py and set the Variable ALLOWED_HOSTS. Execute "python manage.py collectstatic" to create a folder including all static files. Then add PaTT to your server configuration. See also [Django Documnetation](https://docs.djangoproject.com/en/3.1/howto/deployment/) for further information. - -## Start the Test or development System -### Go to the folder, where your PaTT-Application is locates (here ~/tmp/piki) - cd ~/tmp/piki - -###Activate your Virtual Environment - source activate - -###Start the Server - python manage.py runserver +Piki is a minimal wiki. You find further information under https://piki.mount-mockery.de \ No newline at end of file