1. Learn
2. Installation

Installing Weavy

When installing Weavy, the first step is to deploy a Weavy backend a.k.a environment. For quick and easy setup, we recommend using the Weavy Cloud. But if you need full control and want to host Weavy in your own infrastructure, we also offer the option to self-host Weavy.

Weavy Cloud

From your account dashboard we have made it quick and easy to create and manage environments. Each environment gets a dedicated management page where you can create API keys, view usage statistics, logfiles etc.

DevOps

As mentioned above, it is possible to create multiple environments in the Weavy Cloud. Each environment gets its own unique URL and storage area, and can be configured to run different versions of Weavy if needed.

Many organizations use the multi-environment support for their DevOps pipeline with environments for "Development", "Staging" and "Production". Others use it to deploy separate Weavy environments for different customers, regions, products etc.

Security

Our cloud environments are powered by Microsoft Azure and we keep your data secure with best-in-class security - data is encrypted both in transit and at rest.

Self-hosting

We understand that there are scenarios when you need full control and want to host Weavy in your own infrastructure. For such scenarios we offer the option to self-host Weavy in the location of your choice, e.g. private cloud, on-prem etc.

For self-hosting you need to be on the self-hosted plan.

We recommend using Docker for self-hosting, but we also have options for running Weavy directly on a local workstation or server if you prefer that option. Additionally, we support deploying to Azure App Service and AWS Elastic Beanstalk.

Docker compose

Weavy provides a container image for use with Docker or other containerization tools. Here is an example compose file:

services:
  weavy:
    image: weavy/weavy
    restart: always
    depends_on:
      - db
    environment:
      - ASPNETCORE_KESTREL__CERTIFICATES__DEFAULT__PATH=/https/weavy.pfx
      - ASPNETCORE_KESTREL__CERTIFICATES__DEFAULT__PASSWORD=weavy
      - CONNECTIONSTRINGS__WEAVY=host=db;database=weavy;username=weavy;password=weavy;gss encryption mode=disable;
      - WEAVY__LICENSE={YOUR-LICENSE-KEY}
    ports:
      - 8080:8080
      - 8081:8081
    volumes:
      - ~/.aspnet/https:/https:ro
  db:
    image: postgres
    restart: always
    environment:
      - POSTGRES_USER=weavy
      - POSTGRES_DB=weavy
      - POSTGRES_PASSWORD=weavy
    volumes:
      - pgdata:/var/lib/postgresql/
volumes:
  pgdata:

Weavy is based on ASP.NET Core and requires HTTPS/TLS. For details on how to acquire and configure a certificate, see Hosting ASP.NET Core images with Docker Compose over HTTPS. In the example above, we assume you have a self-signed development certificates at ~/.aspnet/https/weavy.pfx with the password weavy.

Configuration

As seen above, environment variables are used to add and modify configuration values. As a minimum, you need to supply your license key with WEAVY__LICENSE={YOUR-LICENSE-KEY}.

Start Weavy

Start Weavy with docker compose up and open https://localhost:8081 in your browser. If everything worked out you should see the Weavy logo on your screen.

Create admin account

Next step is to create a local admin account for managing Weavy. Go to /admin/account and fill in the form to create an admin account and gain access to the /admin section where you can create API keys, view log files etc.

Troubleshooting

If the application does not start, or if you get an error on startup, the console should contain an error message describing the problem. A common problem is missing or invalid configuration settings.

Next steps

After you have created the Weavy environment, your next step should be adding the UIKit to your application and start using Weavy.