Letterpad
Search…
Installation and Setup
Building a client
Others
Production
This guide is intended for self hosters, looking for a step-by-step guide to getting Letterpad installed, setup and configured on their own servers
If you're looking to install Letterpad on your local machine, perhaps just to test it out or to develop a theme, please follow the local install guide instead.
Create A Non-root User
We will create a new user, letterpad, with sudo access as its not advised to do everything as the root user:
1
adduser letterpad
Copied!
Follow the prompts to set the new user’s name and password. You can leave all the other fields blank by hitting Enter.
Now let’s add the new user to two groups:
1
gpasswd -a letterpad sudo
2
gpasswd -a letterpad www-data
Copied!
This gives the
letterpad user administrative access and adds it to the same group as Nginx, which we'll get to later.Configure Environment
First, let’s run system updates:
1
sudo apt-get update && sudo apt-get upgrade -y
Copied!
Now let’s install git, nodejs and nginx server:
Letterpad requires min Node v8.10.0+, but we will install the latest one directly from the NodeSource repo:
1
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
2
sudo apt-get install -y nodejs
Copied!
Install yarn. We will use yarn instead of npm to manage dependencies.
1
sudo curl -o- -L https://yarnpkg.com/install.sh | bash
Copied!
Install Letterpad
Since we’re installing with the beta version of Letterpad, we need to build it from the source. Let’s start by cloning the repo from GitHub:
1
cd /var/www
2
sudo git clone https://github.com/letterpad/letterpad.git
3
sudo chown -R $USER:www-data /var/www/letterpad
4
cd letterpad
Copied!
This will create
/var/www/letterpad and copy the source from GitHub.Next we need to copy
.env.development.local to .env.production.localfile. Setup your production configurations in this file. 1
cp .env.development.local .env.production.local
2
nano .env
Copied!
Next, change
SECRET_KEY to a random string. Just make sure it's reasonably long and random.Lastly, update the SMTP section. This section is important, otherwise you won’t be able to create users, reset passwords, etc. If you don’t already have a transactional email service, you may use your gmail credentials to configure this.
Now save the file by pressing
ctrl + x, y, enter.Configure Nginx
Now we need to configure Nginx to act as a reverse proxy for Letterpad. All the traffic will first hit this nginx server and then nginx server will route this to your nodejs server where letterpad is running.
Let’s replace the default nginx config with a custom one:
1
sudo nano /etc/nginx/sites-available/default
Copied!
Delete everything and paste the following:
1
server {
2
listen 80;
3
server_name example.com;
4
5
# Max upload size for proxy
6
client_max_body_size 100m;
7
8
location / {
9
proxy_pass http://localhost:3030/;
10
proxy_http_version 1.1;
11
proxy_set_header Upgrade $http_upgrade;
12
proxy_set_header Connection 'upgrade';
13
proxy_set_header Host $host;
14
proxy_cache_bypass $http_upgrade;
15
}
16
}
Copied!
Make sure to change
yourdomain.com to the same domain or IP address you used in the .env file.Save and exit by pressing
ctrl + x, y, enter.Now test the config and restart Nginx:
1
sudo nginx -t
2
sudo systemctl restart nginx
Copied!
Install Dependencies
We will use — production=false as an argument to install the devDependencies as well for building optimised letterpad assets.
1
yarn install --production=false
Copied!
Build Letterpad
Before starting letterpad, we have to create the optimized bundles. We can do so by entering the below command in your terminal.
1
yarn build
Copied!
This will build the letterpad admin dashboard.
Run Letterpad
Once that is done, we will run the below command to turn on letterpad. Remember to have the environment variable
NODE_ENV to production 1
yarn start
Copied!
If everything is setup properly, you’ll be able to access Letterpad from the URL or IP address you entered in the last step.
Run continiously
To run any nodeJS application continiously, we will need a task runner like pm2 to launch and monitor the app. If Letterpad crashes, pm2 will restart it. If your droplet gets restarted, pm2 will make sure Letterpad relaunches on startup.
1
yarn global add pm2
2
pm2 start yarn --name "letterpad" --interpreter bash -- start
3
sudo pm2 startup systemd
Copied!
If you encounter any issues with the above article, drop a comment and we will try to fix it together.
Last modified 6mo ago