The general goal of this project is to provide a wiki in which several service providers can be mapped without having to rewrite each topic for each one.
The integration of corporate logos is also planned.
- Begin by cloning the repository to a designated local directory on your machine.
git clone https://github.com/jcivitel/whitelabel-wiki.git
- Launch a Command Prompt (CMD) and navigate to the specified directory. Once in the directory, execute the following command:
python -m venv venv
- Once the virtual Python environment has been successfully created, it is now possible to execute the script by the following steps:
. venv/bin/activate
pip install -r reqirements.txt
- You need to set your own environmental variables.
Tip
create a .env file or use the Docker environment
- To run the server, execute the following command:
python manage.py runserver
Note
By default, the runserver command starts the development server on the internal IP at port 8000.
If you want to change the server’s port, pass it as a command-line argument. For instance, this command starts the server on port 8080:
python manage.py runserver 8080
If you want to change the server’s IP, pass it along with the port. For example, to listen on all available public IPs (which is useful if you are running Vagrant or want to show off your work on other computers on the network), use:
python manage.py runserver 0.0.0.0:8080
version: "3.3"
services:
wiki:
container_name: wiki
image: jcivitell/whitelabel_wiki:latest
ports:
- "80:8000/tcp"
environment:
SECRET_KEY: '${SECRET_KEY}'
DEBUG: '${DEBUG}'
LANGUAGE_CODE: '${LANGUAGE_CODE}'
TIME_ZONE: '${TIME_ZONE}'
MAIN_DATABASE_ENGINE: '${MAIN_DATABASE_ENGINE}'
MAIN_DATABASE_NAME: '${MAIN_DATABASE_NAME}'
MAIN_DATABASE_USER: '${MAIN_DATABASE_USER}'
MAIN_DATABASE_PASSWD: '${MAIN_DATABASE_PASSWD}'
MAIN_DATABASE_HOST: '${MAIN_DATABASE_HOST}'
MAIN_DATABASE_PORT: '${MAIN_DATABASE_PORT}'
networks:
- wiki
mariadb:
container_name: db
image: mariadb:latest
environment:
MARIADB_ROOT_PASSWORD: '${MARIADB_ROOT_PASSWORD}'
MYSQL_DATABASE: '${MAIN_DATABASE_NAME}'
MYSQL_USER: '${MAIN_DATABASE_USER}'
MYSQL_PASSWORD: '${MAIN_DATABASE_PASSWD}'
volumes:
- 'data:/var/lib/mysql'
networks:
- wiki
networks:
wiki:
volumes:
data: