Installation

To install webweb2, it is recommended to use Docker. If you don't want to for whatever reason, you can also run it without using Docker.

Use forwarded headers

For both installation types, you'll need to configure webweb2 to use forwarded headers (assuming you'll use Nginx to forward traffic to the application). First, clone the GitHub repository:

git clone <https://github.com/merlin04/webweb2>

Now, cd into the BlazorEditor directory in the newly cloned repository, and run:

patch -u Startup.cs -i UseForwardedHeaders.patch

This will apply the necessary changes to the code to enable forwarded headers.

Docker installation

First, make sure you have docker and docker-compose installed. After you verify that, you'll need to create a docker-compose.yml file in the root of the cloned directory. Here's an example:

version: '3.8'
services:
    blazoreditor:
        build: .
        ports:
            - "5000:80"
        volumes:
            - /webweb-storage/app.db:/app/app.db
            - /webweb-storage/wwwroot:/app/wwwroot

You'll need to replace /webweb-storage with the directory that you want to have webweb2 store its files in. After you've made that file, create an empty file in your storage directory called app.db, and create a directory called wwwroot. Finally, make a directory called garbage in wwwroot/webwebResources. To run webweb2, cd to the cloned repo and run docker-compose up. The application will run on port 5000 (if needed, you can change that in the docker-compose.yaml file), and you can use a reverse proxy like Nginx to serve it on the correct port on a domain.

Non-Docker installation

To run webweb2 without using docker, follow Microsoft's guide here. You do not need to follow the steps that modify Startup.cs to enable forwarded headers; following the instructions in the "Use forwarded headers" section will have already done that.

Additional Nginx configuration

With the configuration settings from Microsoft's guide on deploying an ASP.NET Core app, the app will get disconnected from the server very frequently and will display an overlay saying that it is trying to reconnect for a few seconds. This is a known issue, and Microsoft is working on documentation to fix it. See here for details on the fix and the status of the instructions.

Setup

The setup process for webweb2 is very straightforward. The first time you go to the web address for webweb2, you'll see a register page. Choose a username and password and click register.

<aside> 💡 The register page is only publicly accessible when there aren't any accounts. Creating your account will mean that no one else can create an account, unless you choose to let them.

</aside>

After doing that, you'll see the startup screen of webweb2. This has access to all of the commonly used functions, but before you do any of that, you should make sure everything is properly configured (technically, this is not necessary yet, but it's best to do it first). Click on the "Configure webweb" button, and you'll see a new dialog that has fields for you to configure.