Skip to content

FAQ_EN.md

Latest commit

 

History

History
175 lines (128 loc) · 6.87 KB

FAQ_EN.md

File metadata and controls

175 lines (128 loc) · 6.87 KB

LAT-Lab Frequently Asked Questions (FAQ)

This document collects common questions and answers during the use of the LAT-Lab project.

🚀 Deployment Related

Q: How to modify the default administrator account?

A: Running python scripts/init_db.py will create a default administrator account (admin/admin123). It's recommended to change the password immediately in the admin panel.

Q: How to configure email service?

A: Configure SMTP credentials in your .env (or docker.env.example) file. The configuration sections in Docker Deployment Guide and Traditional Installation Guide list the required variables and examples.

Q: What to do when ports are occupied during Docker deployment?

A: You can resolve this in the following ways:

  1. Modify port mappings in docker-compose.yml
  2. Use netstat -tulpn | grep :port_number to view occupying processes
  3. Use sudo kill -9 <PID> to kill occupying processes

Q: What should be paid attention to in production environment deployment?

A: When deploying to production environment:

  1. Never use npm run dev, must use npm run build
  2. Configure HTTPS certificates
  3. Set strong passwords and secure SECRET_KEY
  4. Configure firewall and access control
  5. Regular data backup

🔧 Feature Usage

Q: Can themes be customized?

A: Yes. Update the theme stylesheets under frontend/src/assets (for example theme-light.css, theme-dark.css, theme-neon.css) or tweak Vue components directly. Refer to frontend/README.md for build commands after applying your changes.

Q: How to add new plugins?

A: Review the sample plugins in backend/plugin_examples and the metadata format in backend/src/lat_lab/marketplace_config.json. Once your plugin follows the same structure, you can side-load it or publish it to the Plugin Marketplace.

Q: Which databases are supported?

A: SQLite is supported by default, while MySQL 8.0+ is recommended for production workloads. Configuration examples are included in Docker Deployment Guide and Traditional Installation Guide.

Q: How to backup and restore data?

A: Data backup methods:

  1. Database backup: docker-compose exec db mysqldump -u root -p lat_lab_db > backup.sql
  2. File backup: tar -czf uploads_backup.tar.gz uploads/
  3. Complete backup: Combine the database dump and uploaded files archive (or snapshot your Docker volumes)

🐛 Troubleshooting

Q: What to do when service startup fails?

A: Troubleshoot according to the following steps:

  1. Check logs: ./deploy.sh logs or docker-compose logs
  2. Check environment configuration: Confirm .env file configuration is correct
  3. Check port occupancy: Confirm required ports are not occupied
  4. Check resources: Confirm sufficient memory and disk space

Q: Frontend page displays abnormally?

A: Possible causes and solutions:

  1. API connection failure: Check if backend service is running normally
  2. Static resource loading failure: Check if frontend build is correct
  3. Browser compatibility: Recommend using modern browsers

Q: Email sending fails?

A: Email sending problem troubleshooting:

  1. Check if SMTP configuration is correct
  2. Confirm if email service provider supports SMTP
  3. Check network connection and firewall settings
  4. View email service logs

🔒 Security Related

Q: How to improve system security?

A: Security recommendations:

  1. Regularly update passwords and SECRET_KEY
  2. Enable HTTPS
  3. Configure firewall rules
  4. Regular data backup
  5. Monitor system logs
  6. Update dependencies promptly

Q: What to do when security vulnerabilities are found?

A: Please report security vulnerabilities through the following ways:

  1. Send email to security@luminarc.tech
  2. Create private Issue on GitHub
  3. Describe vulnerability situation and reproduction steps in detail

📱 Mobile Support

Q: Does it support mobile access?

A: Yes, LAT-Lab adopts responsive design and supports various mobile devices. It's recommended to use modern browsers on mobile devices for the best experience.

Q: Are mobile features complete?

A: Mobile supports all core features, including:

  • Article browsing and search
  • User login and registration
  • Comment publishing and replies
  • Admin panel operations

🔌 Plugin Development

Q: How to develop custom plugins?

A: Suggested workflow:

  1. Review the reference plugins in backend/plugin_examples
  2. Copy an example into backend/plugins (or your own repository) and adjust the metadata defined in backend/src/lat_lab/marketplace_config.json
  3. Implement and test your functionality locally
  4. Package the plugin and, if desired, publish it to the Plugin Marketplace

Q: What skills are needed for plugin development?

A: Plugin development requires:

  • Basic Python programming knowledge
  • Understanding of FastAPI framework
  • Familiarity with HTML/CSS/JavaScript
  • Understanding of Vue.js component development

📊 Performance Optimization

Q: How to improve system performance?

A: Performance optimization suggestions:

  1. Use CDN to accelerate static resources
  2. Configure database indexes
  3. Enable caching mechanisms
  4. Optimize images and media files
  5. Use load balancing

Q: Does it support high concurrency access?

A: LAT-Lab adopts asynchronous architecture and supports high concurrency access. It's recommended to use in production environment:

  • Multi-instance deployment
  • Load balancing
  • Database read-write separation
  • Caching strategies

🌐 Internationalization

Q: Does it support multiple languages?

A: Currently supports Chinese and English, and additional locales are planned. To add another language, replicate the existing translation resources under frontend/src (layouts, copy, and locale files) and submit the changes through a pull request.

Q: How to switch languages?

A: Language switching methods:

  1. Select language in user settings
  2. Specify language through URL parameters
  3. Automatically select based on browser language

📞 Getting Help

If this document doesn't solve your problem, you can get help through the following ways:

  1. View Documentation: Documentation Center
  2. Search Issues: Search in GitHub Issues
  3. Create Issue: Create new Issue describing the problem
  4. Participate in Discussion: Exchange ideas in GitHub Discussions
  5. Email Contact: contact@luminarc.tech

🌟 If this FAQ helps you, please give the project a Star ⭐

Made with ❤️ by Dawn_ARC