Skip to content

Standardize capitalization of docassemble #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nonprofittechy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Standardize capitalization of docassemble #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ yarn.lock
.yarn
.yarn/
.pnp.cjs
.pnp.loader.mjs
.pnp.loader.mjs
.codex
16 changes: 8 additions & 8 deletions docs/admin_guide_docassemble/rebuild-lightsail-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Rebuilding your AWS Lightsail instance
sidebar_label: Rebuilding your AWS Lightsail instance
---

## Rebuilding your Docassemble server
## Rebuilding your docassemble server

Periodically, a new version of Ubuntu that runs in your Lightsail container
will be available. A new [Long-term Support (LTS)](https://wiki.ubuntu.com/LTS)
Expand All @@ -17,23 +17,23 @@ the specifications. For example, you can upgrade to a container with more RAM,
CPUs, or storage space.

The good news is that you can update the Ubuntu software in your Lightsail
container and connect it to your existing Docassemble database. This saves time and
container and connect it to your existing docassemble database. This saves time and
minimizes changes.

## Before you begin

This process involves backing up files, creating a new AWS Lightsail instance, and
connecting the new instance to your database. It will create a new Docker container.
The new Docker container will be running the latest version of Docassemble and other
The new Docker container will be running the latest version of docassemble and other
installed packages. The process usually takes around 1 hour, so do it when you can
afford your Docassemble server to be unavailable for a while.
afford your docassemble server to be unavailable for a while.

This guide assumes you already have an existing, functional Docassemble server with
This guide assumes you already have an existing, functional docassemble server with
the following setup:
- AWS Lightsail instance
- AWS S3 data storage
- Docker container
- Docassemble web app
- docassemble web app

It also assumes you can access all those items through AWS, including SSH access to
the Lightsail instance. See
Expand Down Expand Up @@ -83,7 +83,7 @@ When complete, in AWS, go to the Lightsail instance and click **Stop**.

## Back up S3 files

You can now make a copy of the Docassemble files that are stored in your S3 bucket. Most
You can now make a copy of the docassemble files that are stored in your S3 bucket. Most
of the time you won't need to use these backups. It's reassuring to have a backup copy.

Sign into AWS, and go to your Amazon S3 Buckets. Click on the server you want to upgrade.
Expand All @@ -102,7 +102,7 @@ In AWS Lightsail, you can make a new instance by following these steps.
- Be sure to match the geographical zone where old server is located.
- Select the platform: Unix/Linux.
- Select a blueprint: Under the 'Operating System (OS) only' tab, select Ubuntu 22.04 LTS (or the latest version).
- Choose your instance plan: Most new Docassemble instances use the 4GB Memory option.
- Choose your instance plan: Most new docassemble instances use the 4GB Memory option.
- Give your server a name under Identify your instance. This can't be the same as your existing instance.
You might want to include the Ubuntu version or year. It is helpful to include something
like "Dev" or "Prod" to keep these types of severs distinct. For example, you could name the
Expand Down
12 changes: 6 additions & 6 deletions docs/admin_guide_docassemble/run-docassemble-docker-vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: run-docassemble-docker-vscode
title: Setup & Run Docassemble with Docker and VS Code
sidebar_label: Docassemble with Docker and VS Code
title: Setup & Run docassemble with Docker and VS Code
sidebar_label: docassemble with Docker and VS Code
---

Author: [Dele Omotosho](https://github.com/deletosh)
Expand Down Expand Up @@ -108,7 +108,7 @@ Skip this step on MacOS
![](https://i.imgur.com/LRiO87R.gif)

## Install Python and docassemble command-line app
Docassemble is written in the Python programming language. To make docassemble work offline, we need to install Python.
docassemble is written in the Python programming language. To make docassemble work offline, we need to install Python.

### Install Python on WSL
Skip this step on MacOS
Expand Down Expand Up @@ -161,7 +161,7 @@ Here’s how:
![](https://i.imgur.com/GF8SmxY.gif)
- Open your browser and go to `http://localhost`. You might see this
![](https://i.imgur.com/VaFLb62.png)
- After a few minutes, you should see Docassemble running.
- After a few minutes, you should see docassemble running.
- Sign in with the default password:
- username: admin@admin.com
- password: password
Expand All @@ -172,7 +172,7 @@ Here’s how:
### Run your first offline docassemble

Our main setup is now complete. Let's test our first interview.
First, go to Docassemble running on your system. In your browser, type **http://localhost**, in the navigation section, click **My Profile**.
First, go to docassemble running on your system. In your browser, type **http://localhost**, in the navigation section, click **My Profile**.

![](https://i.imgur.com/Wq4KE1X.png)

Expand Down Expand Up @@ -221,7 +221,7 @@ When we make changes to our files on VS Code, we need to re-run the `dainstall -

## Points to have on mind while writing interviews locally

here are some things you need to keep in mind with developing Docassemble
here are some things you need to keep in mind with developing docassemble
locally:

- Every docassemble project is self-contained and you need to re-start Docker in each project.
Expand Down
24 changes: 12 additions & 12 deletions docs/admin_guide_docassemble/running-docassemble-without-aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
slug: running-without-aws
title: Running Docassemble without AWS and S3
sidebar_label: Running Docassemble without AWS
title: Running docassemble without AWS and S3
sidebar_label: Running docassemble without AWS
---

## Motivation

In most situations, we recommend that you follow ["Installing a Docassemble Server"](setup-server) and use a hosted
In most situations, we recommend that you follow ["Installing a docassemble Server"](setup-server) and use a hosted
virtual server with S3 compatible storage, which will give you more resilient servers and easier backups. If
for some reason you need to host all of you servers on premises and cannot use cloud servers, this guide should
be helpful.
Expand All @@ -16,16 +16,16 @@ be helpful.
These are mostly the same steps from ["Choose a DNS Name"](setup-server#choose-a-dns-name) and ["Create an 'A' record"](setup-server#create-an-a-record-that-points-to-the-reserved-ip-address-in-your-dns-providers-website). If you are hosting your own servers,
you will need to find out what IP address you have and point the 'A' record to that address.

## Start the Docassemble server
## Start the docassemble server

### Install Docker

Even if you are running Docassemble on your own server, we still recommend that you use Docker
to run docassemble. As described in [the Docassemble documentation](https://docassemble.org/docs/installation.html#docker), running Docassemble without Docker is a significantly complicated exercise, with multiple long-running and reoccuring processes, and there are not many benefits that you can get from doing it.
Even if you are running docassemble on your own server, we still recommend that you use Docker
to run docassemble. As described in [the docassemble documentation](https://docassemble.org/docs/installation.html#docker), running docassemble without Docker is a significantly complicated exercise, with multiple long-running and reoccuring processes, and there are not many benefits that you can get from doing it.

So, the first step to starting the Docassemble server is to install Docker. This can follow the same steps from ["Install Docker"](setup-server#install-docker). If you are running on a different OS than linux, you should follow [Docker's official installation instructions](https://www.docker.com/get-started/).
So, the first step to starting the docassemble server is to install Docker. This can follow the same steps from ["Install Docker"](setup-server#install-docker). If you are running on a different OS than linux, you should follow [Docker's official installation instructions](https://www.docker.com/get-started/).

### Start Docassemble
### Start docassemble

You can first create an `env.list` file, which should contain the following:

Expand All @@ -39,15 +39,15 @@ DAEXTRAFONTS=false
DAGOOGLEFONTS=false
```

Then, you can start Docassemble.
Then, you can start docassemble.

```bash
docker run -d -p 443:443 -p 80:80 -v dabackup:/usr/share/docassemble/backup --restart unless-stopped --env-file env.list --stop-timeout 600 --name docassemble jhpyle/docassemble
```

## Upgrading the Docassemble server
## Upgrading the docassemble server

The above command (specifically the `-v` argument) created a docker volume that saves all information from the `/usr/share/docassemble/backup` directory somewhere separate from the Docassemble container on your machine. To upgrade to a newer version of the Docassemble container, you can do so without any extra commands handling the data.
The above command (specifically the `-v` argument) created a docker volume that saves all information from the `/usr/share/docassemble/backup` directory somewhere separate from the docassemble container on your machine. To upgrade to a newer version of the docassemble container, you can do so without any extra commands handling the data.

```bash
docker stop -t 600 docassemble
Expand All @@ -73,7 +73,7 @@ at any time.
## Restoring Backup data

If you want to rollback to data from a certain date, first stop the existing
Docassemble container, and create (but don't start) a new one:
docassemble container, and create (but don't start) a new one:

```bash
docker stop -t 600 docassemble
Expand Down
16 changes: 8 additions & 8 deletions docs/admin_guide_docassemble/setup-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Installing a docassemble server
# What this guide is

There are a lot of [ways you can install
Docassemble](https://docassemble.org/docs/installation.html). This is one quick
docassemble](https://docassemble.org/docs/installation.html). This is one quick
path that will help you get started quickly without having to make your own
choices.

Expand Down Expand Up @@ -213,7 +213,7 @@ newgrp docker

### Setup a Linux swap file

While the 4 GB RAM allocation is almost always enough, Docassemble can have odd
While the 4 GB RAM allocation is almost always enough, docassemble can have odd
moments where the RAM usage spikes up quickly, which can crash the server. This
is somewhat more likely to be a problem on a development server.

Expand Down Expand Up @@ -263,7 +263,7 @@ Update the values as follows:
and to set the time that daily scheduled cron scripts run.
* Set LETSENCRYPTEMAIL to an email of your choice. You will receive messages at this
address if your certificate is about to expire, but otherwise will not.
* In Docassemble version 1.8.14 and later, if DAEXTRAFONTS and DAGOOGLEFONTS are true they
* In docassemble version 1.8.14 and later, if DAEXTRAFONTS and DAGOOGLEFONTS are true they
will install those fonts on startup. These might be necessary for your interviews that do
DOCX to PDF conversion.

Expand Down Expand Up @@ -377,22 +377,22 @@ Compose file to ensure you are setting the same flags in the new container.

## Sit back and wait

In a few minutes, your Docassemble server will be up and running. Visit the website at the DNS
In a few minutes, your docassemble server will be up and running. Visit the website at the DNS
name you chose, `https://apps.example.com`. Log in with the default username and password,
admin@admin.com/password. Change it to something more secure.

### Monitor progress

While the server starts up, you can run this command to monitor the container's progress, if
Docassemble is the only docker container in your server:
docassemble is the only docker container in your server:

```bash
docker exec -ti $(docker ps --format '{{.Names}}') sh -c "tail -f /var/log/supervisor/initialize-stderr*"
```

If you have more than one container, you can modify the command as follows:

Note the name of the Docassemble container, which should be listed in the output of `docker ps`
Note the name of the docassemble container, which should be listed in the output of `docker ps`
In the command below, replace [YOUR CONTAINER NAME] with the name of your container.

```bash
Expand All @@ -410,10 +410,10 @@ updating, you should just stay patient.
I recommend at least 2 servers: a production server and a development server. You may also want
a test server, for a total of 3.

Production should have the most stable version of Docassemble. Development can test bleeding edge code.
Production should have the most stable version of docassemble. Development can test bleeding edge code.
Test should mirror Production as much as possible.

If you want to configure load balancing, that is something I have not experimented with in Docassemble. Cost
If you want to configure load balancing, that is something I have not experimented with in docassemble. Cost
will be much higher but it may be worthwhile. You still will want at least a test/dev and production environment.

## Further reading
Expand Down
Loading
Loading