Learn how to set up and manage an OpenLingu server
This guide assumes you have basic knowledge of Python, virtual environments, and working with the command line. You'll need:
All the files needed to set up your own OpenLingu server are located in the server directory of the repository. Make sure you're in this directory when running the server commands.
OpenLingu's backend is built with FastAPI, a modern, high-performance web framework for building APIs with Python. The server is designed to be hosted using Uvicorn, a lightning-fast ASGI server implementation.
OpenLingu's decentralized approach allows anyone to create and host their own server with custom learning content. Each server can offer unique learning experiences through:
OpenLingu's decentralized approach allows anyone to create and host their own server with custom learning content. Each server can offer unique learning experiences through:
Create and share your own language courses with tailored content and exercises.
Build a community around your teaching methods and resources.
Implement your unique teaching approach through customizable exercises.
This ecosystem enables learners to access diverse learning materials through the OpenLingu client application.
# Create and activate virtual environment
python -m venv venv
source venv/bin/activate # On Windows: .\venv\Scripts\activate# Install system dependencies (Linux/Ubuntu)
sudo apt update
sudo apt install -y python3-pip python3-venv python3-dev python3-tk \
build-essential libssl-dev libffi-dev libxml2-dev libxslt1-dev \
zlib1g-dev libjpeg-dev libpng-dev libpq-dev
# Install Python packages
pip install fastapi>=0.68.0 uvicorn>=0.15.0 python-jose>=3.3.0 \
passlib[bcrypt]>=1.7.4 sqlalchemy>=1.4.23 python-multipart \
python-dotenv pydantic[email] psycopg2-binaryFor development with auto-reload:
uvicorn server.main:app --reloadFor production with Gunicorn:
gunicorn -k uvicorn.workers.UvicornWorker server.main:app \
--workers 4 \
--bind 0.0.0.0:8000 \
--timeout 120 \
--keep-alive 5Server administrators can manage contributor accounts using the built-in admin tools. These tools allow you to create, list, and remove contributor accounts with appropriate permissions.
# Navigate to the server directory
cd server
# Run the admin tools
python -m admin.toolsCreates a new contributor account with the specified username and password.
# Select option 1 from the menu
1Displays a list of all registered contributors.
# Select option 2 from the menu
2Removes a contributor account. This action cannot be undone.
# Select option 3 from the menu
3These admin tools provide direct access to the server's user database. Please ensure that:
Testing Locally
You can use these admin tools with your local development server. After creating a contributor account,
log in to the Lection Creator using http://localhost:8000
with the credentials you just created.
Detailed API endpoints, request/response examples, and more