SobekCM Repository Community Help
SobekCM Repository

Getting SobekCM

 

Before continuing with installation, you may want to review the server architecture documentation and the requirements documentation.

Installation Components

There are several installation components which will need to be installed. As the installer, you will need to decide which services you wish to put on the same servers after reading the server architecture documentation. You will need a web server running IIS and .NET 10 for the web application. You will also need access to a Microsoft SQL or PostgresSQL database and a server running Solr/Lucene. It will often make sense to run these on the same server, along with the SobekCM Builder/Bulk Loader software.

It is best to at least determine where your database will live first. Then, you can skip ahead to installing the web application followed by the builder/bulk loader. The Solr/Lucene can be installed at any time during this process. The notes below will guide you through the installation process for each of the components:

Instructions for getting the main web application working are detailed below.

Building the Software

To deploy the software locally, you will need to clone the Github repository locally first and then build it.

git clone --branch v5.0.0 --single-branch --depth 1 https://github.com/SobekCM/SobekCM-Web-Application

Compilation to publish the web page can be completed by running the build_release.bat script included in the Scripts folder. This will deploy the release version to your local C:\Staging\Web directory. If you have a deploy.bat file in C:\Staging, it will also call that at the very end of the build script. An example deploy script is provided under the same Scripts folder to give you an idea some things you could to there.

Deploying the Software

The following steps will deploy your newly built code:

  1. Copy everything under C:\Staging\Web to your IIS web server, under the inetpub\wwwroot folder most likely
  2. Configure a web application under IIS pointed at that spot
  3. The application pool should be No Managed Code and edit the Application Pool Identity under the Advanced Settings to be the appropriately permissioned local user.
  4. Under the website, set Anonymous Authenticion on and tell it to connect at the Application Pool Identity
  5. Under the basic site settings, also set it to connect as the Application Pool Identity
  6. Create a content folder under the main application as well, to work temporarily as your digital resource store.
  7. Add appropriate bindings for your site in IIS as well.

Next, set the application to reach the database you created.

Under the config folder you will find a sobekcm.config file (or a template file for that). You will want to add your connection string to it. Below is an example connecting to a MS SQL database using SQL Authentication.


<?xml version="1.0" encoding="UTF-8" ?>
<SobekCM_Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://sobekrepository.org/schemas/sobekcm_config"
        xsi:schemaLocation="http://sobekrepository.org/schemas/sobekcm_config
                             http://sobekrepository.org/schemas/sobekcm_config.xsd">

  <Connections>
    <Connection_String  type="MSSQL" isHosted="false">data source=server-name\SQLEXPRESS;initial catalog=MYCATALOG;user id=MYUSER;password=MYPASSWORD;TrustServerCertificate=True;Encrypt=False;</Connection_String>
  </Connections>

  <ErrorHandling>
    <ErrorEmails></ErrorEmails>
    <ErrorPage>http://192.168.7.63/error.html</ErrorPage>
  </ErrorHandling>
</SobekCM_Config>

That should be enough to at least launch the site.

 

 

Finished with the installation? Continue to get started. >>