Skip to content

Commit

Permalink
preparing install walkthrough for CMS scenarios
Browse files Browse the repository at this point in the history
  • Loading branch information
@iJungleboy
iJungleboy committed Oct 3, 2024
1 parent 760bfce commit 9306b87
Show file tree
Hide file tree
Showing 79 changed files with 677 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2294,6 +2294,11 @@
"title": "Upgrading Oqtane | Oqtane Docs - APIs and more for the Modular Blazor Application Framework",
"keywords": "Upgrading Oqtane Regularly upgrading Oqtane is crucial to maintain the latest fixes, features, and security patches. Below, you'll find simplified instructions for both manual and automated upgrade processes. Manual Upgrade Performing a manual upgrade ensures full control over the process. Follow these straightforward steps: Step 1: Download Upgrade Package Visit the Oqtane Framework releases page on GitHub. Download the package for your desired version that ends with *.Upgrade.zip (e.g., Oqtane.Framework.5.0.2.Upgrade.zip). Step 2: Access Installation Location Navigate to the root location where your Oqtane framework files were initially deployed. You can identify this location by files with a .dll extension (e.g., Oqtane.Server.dll). Step 3: Stop Oqtane Application Depending on your setup: Stop your website using your web server or cloud provider's interface. In IIS (Internet Information Services), stop the corresponding App Pool. For Apache or Linux alternatives, halt the relevant service. Alternatively, create an app_offline.htm file in the root folder to temporarily shut down your site. Step 4: Replace Files Extract all files from the Upgrade.zip package into the root location obtained in Step 2. When prompted, replace existing files with those from the upgrade package. Step 5: Restart Oqtane Application Restart your Oqtane application: Restart your site using your web server or cloud provider's interface. In IIS, restart the previously stopped App Pool. For Apache or Linux, restart the halted service. If you created an app_offline.htm file, delete it now. Step 6: Verify Upgrade Open your web browser and navigate to your site's URL. The upgrade scripts will automatically execute during application startup. Automated Upgrade Oqtane streamlines the upgrade process for non-technical users with its automated upgrade feature. Follow these steps: Log in to your Oqtane site as the host user. Navigate to the Admin Dashboard via the Control Panel. Choose the \"System Update\" option. 4.If a newer version is available on Nuget.org, click \"Upgrade to #.#.#\" to download and perform the upgrade automatically. If you're already up-to-date, you'll see a message indicating this. Alternatively, use the \"Upload\" tab to manually upload a framework upgrade package to the site and select a button to install it. This method also supports reinstallation or repair of an existing installation with the current version. Note: Automated upgrades may fail due to environmental factors. If this occurs, resort to the manual method described above. Oqtane Automated Upgrade Process By following these instructions, you'll ensure your Oqtane installation stays current with the latest enhancements and security fixes. Remember, stopping the Oqtane application is essential to replace files during the upgrade process. Automated upgrades streamline the process, but manual upgrades provide greater control, especially for custom installations. Resources Oqtane Supported Databases Oqtane Installation Resources ← Back to Installation Home"
},
"manuals/admin/installation/walkthrough-dev/index.html": {
"href": "manuals/admin/installation/walkthrough-dev/index.html",
"title": "Install Oqtane as CMS - Walkthrough for Developers | Oqtane Docs - APIs and more for the Modular Blazor Application Framework",
"keywords": "Install Oqtane as CMS - Walkthrough for Developers This demonstrates a step-by-step walkthrough to install Oqtane on your local development machine. It shows both how to get it running in Visual Studio, as well as installing the extension CMS module 2sxc. Prerequisites This assumes that you have the following software installed on your machine: Visual Studio latest version .NET Core SDK latest version SQL Server If you need guidance on installing any of these prerequisites, refer to the links above. 1. Install Oqtane These slides start by running git clone -b master https://github.com/oqtane/oqtane.framework.git to get the latest build, then open the solution in Visual Studio make minor adjustments compile it run it specify the database connection etc. let the installation run login as super user 2. Install the CMS Extension Module 2sxc These slides show how to install the 2sxc module, which is a powerful content management system (CMS) for Oqtane. 3. Install the Default Content Configuration These slides show how to install the default content configuration for the 2sxc module. The content configuration basically tells the system what kinds of content exist (e.g. videos, text/images, etc.) and how they are presented to the end-user. Once it's installed, you can verify it works by trying to add content. 4. Add an App Apps are packages of functionality which can be added to your Oqtane installation. Typical examples are Blog, News, Galleries, Swipers, Real-Estate-Listings, etc. Related Pages Oqtane Installation Resources ← Back to Installation Home"
},
"manuals/admin/installation/windows-iis-express-sql-express.html": {
"href": "manuals/admin/installation/windows-iis-express-sql-express.html",
"title": "Install Using Windows, IIS Express and MS SQL Express | Oqtane Docs - APIs and more for the Modular Blazor Application Framework",
Expand Down
5 changes: 5 additions & 0 deletions docs/layout/oqtane/public/main.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -253,4 +253,9 @@ pre {
img.full-width {
width: 100%;
padding-bottom: 16px;
}

img.gallery {
width: 23%;
padding: 0 8px 16px 0;
}
370 changes: 370 additions & 0 deletions docs/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5740,6 +5740,376 @@
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/121 Get from Github.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/200 Compile Oqtane.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/201 Disable HotReload.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Installing.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/211 Oqtane Settings.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/291 Oqtane Installed.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/292 Login as Super User.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/293 Oqtane Logged In.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/311 Go to Modules - Open Menu.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/312 Go to Modules - Admin Dashboard.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/313 Go to Modules - Module Management.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/321 Install Module Start.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/322 Select Module.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/323 Accept Module License.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/324 Installed.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/331 Restart Oqtane.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/332 Confirm Restart.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/333 Restarting.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/334 Restart in Visual Studio.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/341 Add Page.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/342 New Page Name and Permissions.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/351 Add Content Module.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/361 Install 2sxc Content Package.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/362 Install 2sxc Content Package - Confirm.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/363 Install 2sxc Content Package - Installing.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/364 Install 2sxc Content Package - Complete.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/371 2sxc Select Content Type.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/372 2sxc Preview Content Type.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/373 2sxc Content Added.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/411 Add App.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/421 App Auto-Installer - Select.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/422 App Auto-Installer - Confirm.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/423 App Auto-Installer - Installing.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/424 App Auto-Installer - Complete.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper - Confirm.jpg"
}
},
"version": ""
},
{
"type": "Resource",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg",
"output": {
"resource": {
"relative_path": "pages/manuals/admin/installation/walkthrough-dev/assets/541 App - Swiper.jpg"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/manuals/admin/installation/walkthrough-dev/index.md",
"output": {
".html": {
"relative_path": "manuals/admin/installation/walkthrough-dev/index.html"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "pages/manuals/admin/installation/windows-iis-express-sql-express.md",
Expand Down
Loading

0 comments on commit 9306b87

Please sign in to comment.