-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* More fixes * Delete src/pages/manuals/admin/admin-management/assets/file-management-folder-permission.png it was nice in codespaces, it would do this for me, but this other way... i have to do it manually, or what am I doing wrong.?! * Rename file-management-folder-permission.png to file-management-folder-permissions.png * fixes links * Update index.md * Update modules.md * Update troubleshooting.md * Update troubleshooting.md * Update troubleshooting.md * Update troubleshooting.md * Update troubleshooting.md * Update toc.yml * Update toc.yml * Update toc.yml * Update toc.yml * Update toc.yml * Update toc.yml * Update troubleshooting.md * Create index.md * Create placeholder.md * Create toc.yml * Create troubleshooting.md * Update troubleshooting.md * Update toc.yml * Create development-production-migration.md * Create troubleshooting-migrations.md * Update troubleshooting.md * Update troubleshooting-migrations.md * Update troubleshooting-developing-themes.md * Update troubleshooting-developing-modules.md * Update index.md * Update toc.yml * Update toc.yml * Update index.md * Update toc.yml * Update toc.yml * Update index.md * Update toc.yml * Update index.md
- Loading branch information
Showing
26 changed files
with
678 additions
and
63 deletions.
There are no files selected for viewing
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Troubleshooting Installations | ||
|
||
## Overview | ||
|
||
This section provides resources and guidance for troubleshooting common installation issues in Oqtane. Whether you're setting up a fresh installation or addressing problems in an existing setup, these guides will help you resolve the most frequent installation challenges. | ||
|
||
### Installation Troubleshooting Guides | ||
|
||
Below are two detailed guides for troubleshooting installations, tailored to the specific needs of users and administrators: | ||
|
||
- **[Installation Issues](../troubleshooting/troubleshooting-installations.md)** | ||
This guide covers troubleshooting tips and solutions for common issues encountered during the installation process of Oqtane. It includes: | ||
- **Installation Failures**: Steps to resolve issues when the installation does not complete successfully. | ||
- **Database Connection Problems**: Solutions for troubleshooting database connection errors. | ||
- **File Permission Issues**: Guidance on fixing file permission problems that may block the installation. | ||
- **Configuration File Errors**: How to troubleshoot configuration file issues that prevent successful setup. | ||
|
||
- **[Upgrading Installations](../troubleshooting/troubleshooting-upgrading-installations.md)** | ||
This guide provides troubleshooting steps specifically for administrators upgrading their Oqtane installation. It addresses: | ||
- **Upgrade Failures**: Identifying and resolving problems during the upgrade process. | ||
- **Compatibility Issues**: Ensuring that the new version of Oqtane is compatible with your existing configuration. | ||
- **Data Migration Problems**: Solutions for handling issues related to data migration during an upgrade. | ||
- **Post-Upgrade Issues**: Resolving issues that arise after the upgrade is complete, such as broken links or missing data. | ||
|
||
These guides are designed to provide practical solutions and best practices to help you install and upgrade Oqtane smoothly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
51 changes: 51 additions & 0 deletions
51
src/pages/guides/migrations/development-production-migration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Migrating Oqtane Framework from Development to Production | ||
|
||
## Overview | ||
|
||
This guide provides step-by-step instructions for migrating an Oqtane Framework instance from a development environment to a production environment. It covers preparation steps, configuration adjustments, and troubleshooting tips to ensure a smooth migration and deployment. | ||
|
||
### Steps for Migrating Oqtane from Development to Production | ||
|
||
Follow the steps below to successfully migrate your Oqtane instance to a production environment: | ||
|
||
#### 1. **Prepare the Development Environment for Migration** | ||
- **Ensure All Features Are Tested**: Before migrating, thoroughly test all modules, features, and configurations in your development environment to ensure everything works as expected. | ||
- **Backup Data and Configuration**: Take a backup of your development database, configuration files, and any custom content or themes you’ve created. | ||
- **Check Version Compatibility**: Ensure that the Oqtane Framework version you're using in development is the same or compatible with the version you're installing in production. | ||
|
||
#### 2. **Prepare the Production Environment** | ||
- **Set Up the Production Server**: Install and configure all necessary components (e.g., web server, database, application server) in your production environment. | ||
- **Set Appropriate File Permissions**: Ensure that your production environment has the correct file permissions, especially for uploads, logs, and configuration files. | ||
- **Configure Security Settings**: Set up SSL certificates, configure firewalls, and ensure that production security best practices are in place. | ||
- **Set Database Connection Strings**: Adjust the connection strings in your production environment to point to your production database server. | ||
|
||
#### 3. **Deploy the Oqtane Framework to Production** | ||
- **Deploy Files**: Copy all files from your development environment (including modules, themes, and content) to your production server. | ||
- **Update Database**: If necessary, run any database migrations or schema updates required to bring the database in sync with the production environment. | ||
- **Update Configuration Settings**: Modify any configuration settings (such as `appsettings.json`) to match the production environment, including things like logging levels, email settings, and application-specific parameters. | ||
|
||
#### 4. **Testing in the Production Environment** | ||
- **Verify the Application**: Once the migration is complete, thoroughly test the application in the production environment to ensure all features and functionalities work correctly. | ||
- **Test Performance**: Ensure that performance is optimal by testing load times, page responses, and checking for bottlenecks. | ||
- **Check Security Configurations**: Verify that SSL is enabled, authentication methods are working, and access control is enforced. | ||
|
||
#### 5. **Go Live** | ||
- **DNS Configuration**: Update your DNS settings to point to your production server. | ||
- **Monitor the Application**: Use monitoring tools to track server performance, logs, and errors in the production environment. | ||
|
||
### Troubleshooting Migration Issues | ||
|
||
If you encounter issues during the migration, here are some common troubleshooting steps: | ||
|
||
- **Configuration Mismatches**: Ensure that all environment-specific settings (such as database connection strings, file paths, and email settings) are updated in the production environment. | ||
- **Missing Files**: Check that all necessary files from development (such as themes, modules, and content) were copied to the production server. | ||
- **Permission Issues**: Ensure that your production environment has the correct file permissions for writing logs, caching, and other necessary operations. | ||
- **Database Connectivity Issues**: Ensure the production server can connect to the production database and that the schema is up to date. | ||
- **Broken Links or URLs**: Double-check any hardcoded URLs or references in configuration files that might be pointing to the development environment. | ||
|
||
### Best Practices for Production Environments | ||
- **Regular Backups**: Set up regular backups for your production database and files. | ||
- **Logging and Monitoring**: Implement comprehensive logging and monitoring solutions for error tracking and performance metrics. | ||
- **Scaling**: Ensure your production server is capable of handling the anticipated traffic, with the option to scale resources as needed. | ||
|
||
This guide helps ensure that your Oqtane Framework instance is ready for production and that any migration issues can be efficiently resolved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
- name: Introduction | ||
href: index.md | ||
|
||
- name: Development to Production Migrations | ||
href: development-production-migration.md | ||
|
||
- name: Troubleshooting | ||
href: troubleshooting.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Troubleshooting Migrations | ||
|
||
## Overview | ||
|
||
This section provides resources and guidance for troubleshooting common issues encountered during the migration of Oqtane instances. Whether you're migrating from an older version or moving Oqtane to a new environment, these guides will help you resolve common migration challenges. | ||
|
||
### Migration Troubleshooting Guides | ||
|
||
Below is a detailed guide for troubleshooting both migration and post-migration issues, tailored to the specific needs of users and administrators: | ||
|
||
- **[Migration and Post-Migration Issues](../troubleshooting/troubleshooting-migrations.md)** | ||
This guide covers troubleshooting tips and solutions for common issues encountered during the migration process of Oqtane, as well as problems that may arise after migration. Topics include: | ||
- Migration failures | ||
- Database migration problems | ||
- Configuration errors | ||
- File path and permission issues | ||
- Missing data or modules | ||
- Broken links or URLs | ||
- Performance degradation | ||
- User authentication problems | ||
|
||
This guide is designed to provide practical solutions and best practices to help you complete and troubleshoot your Oqtane migration successfully. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.