This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Core Tasks

What can your user do with your project?

1: Installing Synclias
2: Installing Synclias
3: Installing Synclias
4: Installing Synclias
5: Installing Synclias
6: Installing Synclias

This is a placeholder page that shows you how to use this template site.

Think about your project’s features and use cases. Use these to choose your core tasks. Each granular use case (enable x, configure y) should have a corresponding tasks page or tasks page section. Users should be able to quickly refer to your core tasks when they need to find out how to do one specific thing, rather than having to look for the instructions in a bigger tutorial or example. Think of your tasks pages as a cookbook with different procedures your users can combine to create something more substantial.

You can give each task a page, or you can group related tasks together in a page, such as tasks related to a particular feature. As well as grouping related tasks in single pages, you can also group task pages in nested folders with an index page as an overview, as seen in this example site. Or if you have a small docset like the Docsy User Guide with no Tutorials or Concepts pages, consider adding your feature-specific pages at the top level of your docs rather than in a Tasks section.

Each task should give the user

The prerequisites for this task, if any (this can be specified at the top of a multi-task page if they’re the same for all the page’s tasks. “All these tasks assume that you understand….and that you have already….”).
What this task accomplishes.
Instructions for the task. If it involves editing a file, running a command, or writing code, provide code-formatted example snippets to show the user what to do! If there are multiple steps, provide them as a numbered list.
If appropriate, links to related concept, tutorial, or example pages.

1 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

2 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

3 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

4 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

5 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…

6 - Installing Synclias

Let’s get Synclias running!

Pre-Requisites

Docker

Before you get started, you’ll need a machine running Docker The best place for guidance on this that I’ve seen is:

W3Schools Installing Docker Page

Get and Set the Config Files

Get the Files

Configure your Install

Copy the example env file to .env Edit the file, we’ll need to change some settings for you. There’s a few, but we’ll deal with them one at a time:

	MARIADB_USERNAME=<any username you like>  
	MARIADB_PASSWORD=<any password you like>  
	MARIADB_DATABASE=synclias
	REDIS_URL=redis://redis:6379/0  
	SECRET_KEY=<< long secret key >>  
	ENCRYPTION_KEY=<< 32 char, url safe string (use a generator, 32 chars, upper,lower,numbers>>

Deal with them one at a time:

Line	Meaning	Suggestion
MARIADB_USERNAME	Database Username	synclias
MARIADB_PASSWORD	Database Password	Anything you want
MARIADB_DATABASE	Database Name	synclias
REDIS_URL	Redis URL	(Leave as is)
FLASK_APP	Point to the app to run. Don’t change this!	opn_alias.app
SECRET_KEY	Browser Data Encryption	See below
ENCRYPTION_KEY	Database Entry Encryption	See below

Secret and Encryption Keys

During the early releases, there’s a limitation on these:

Exactly 32 Characters long
Uppercase, lowercase and numbers only Remember when you put them in, you don’t need quote marks around them, just the plain string

Sorry!

I know this is a pain, I’d suggest a password generator, such as the one at like at - 1Password

You should end up with something like this:

Starting it Up

Almost there!

Just run

docker compose up -d

And let it all come up.

Once it’s working, you can access it at https://localhost:8000

If you get a page like this:

You’re all set to start configuring…