Tutorial: Setting Up - Revision history

Mercury: Fix another putty link

2026-05-22T02:31:36Z

Fix another putty link

Mercury: Update putty link

2026-05-22T02:13:33Z

Update putty link

Mercury at 17:16, 21 November 2021

2021-11-21T17:16:40Z

Mercury at 17:13, 21 November 2021

2021-11-21T17:13:11Z

Mercury: /* .env */

2021-08-15T19:09:56Z

.env

Mercury: /* Command Line Setup */

2021-08-15T17:59:51Z

Command Line Setup

Mercury: /* Command Line Setup */

2021-08-15T17:59:35Z

Command Line Setup

Mercury: /* .env */

2021-08-15T17:49:11Z

.env

Mercury: /* Git Hooks */

2021-08-15T17:39:31Z

Git Hooks

Mercury: /* Obtaining Local and Server Copies */

2021-08-15T17:32:48Z

Obtaining Local and Server Copies

@@ Line 58: / Line 58: @@
 ===Obtaining Local and Server Copies===
-First, we want to make sure we have the software we need. For Windows PCs, download PuTTY from [https://www.putty.org/ here] and install/set it up (click [https://help.dreamhost.com/hc/en-us/articles/215464538-How-do-I-configure-PuTTY- here] for instructions).
+First, we want to make sure we have the software we need. For Windows PCs, download PuTTY from [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html here] and install/set it up (click [https://help.dreamhost.com/hc/en-us/articles/215464538-How-do-I-configure-PuTTY- here] for instructions).
 Next, we need hosting and a domain name. I'll be using Dreamhost in the examples of this tutorial for hosting.

@@ Line 34: / Line 34: @@
 Additional software requirements:
-*[https://www.putty.org/ PuTTY] (if using Windows) / a program that can be used to SSH into your server
+*[https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html PuTTY] (if using Windows) / a program that can be used to SSH into your server
 *A Git client (e.g. [https://www.sourcetreeapp.com/ Sourcetree], recommended if you are new to git, or preferred client if you already have one)
 **You '''must use git, no exceptions'''. This is required to be able to obtain updates, etc.

@@ Line 91: / Line 91: @@
 At this point if you enter <pre>git remote show hub</pre>, you should see something like
   <pre>* remote hub
-    URL: /home/your_username/site-name.com/site_hub.git</pre>Run a git pull.<pre>git pull hub master</pre>
+    URL: /home/your_username/site-name.com/site_hub.git</pre>Run a git pull.<pre>git pull hub main</pre>
 Wait for it to finish running, and if it looks like nothing went wrong, enter <pre>ls</pre> and see that there are files inside the directory.
@@ Line 125: / Line 125: @@
   cd $HOME/site-name.com/www || exit
   unset GIT_DIR
-  git pull hub master
+  git pull hub main
   exec git-update-server-info</pre>

@@ Line 84: / Line 84: @@
 cd site_hub.git
 git --bare init</pre>
-Go to your Git client (e.g. Sourcetree as suggested above), select your folder containing Lorekeeper's code and add site_hub.git as a remote. The address is similar to your SSH address but points directly to the folder, something like <pre><nowiki>ssh://username@host.com/~/site-name.com/site_hub.git</nowiki></pre>If successful, push the code to the remote. In Sourcetree, right click on the remote, choose to push, select the master branch and click OK.
+Go to your Git client (e.g. Sourcetree as suggested above), select your folder containing Lorekeeper's code and add site_hub.git as a remote. The address is similar to your SSH address but points directly to the folder, something like <pre><nowiki>ssh://username@host.com/~/site-name.com/site_hub.git</nowiki></pre>If successful, push the code to the remote. In Sourcetree, right click on the remote, choose to push, select the main branch and click OK.
 Back in the SSH client, we'll add site_hub.git as a remote for www.
@@ Line 139: / Line 139: @@
 For a small but important tweak, we'll change the origin of our repository to point to the new site.
-#Checkout the site's master branch.
+#Checkout the site's main branch.
 #Rename the old origin branch.
-#Change the site's master branch to origin.
+#Change the site's main branch to origin.
 In the future, you (and other users who have access to the repository) can simply push new changes to the code through your Git client at the click of a button, which also keeps track of files that you've added and/or modified, and contains a log of who made what changes to the code. Hooray!

@@ Line 186: / Line 186: @@
 ===.env===
-Now, let's use that information. The site requires a file named .env to be placed in the root directory of your site (in the www directory). Create this file locally, with the following contents/filling out the fields as noted (avoid using spaces in names):
+Now, let's use that information. The site requires a file named .env to be placed in the root directory (in www). Create this file locally, with the following contents/filling out the fields as noted (avoid using spaces in names):
 <pre>

@@ Line 244: / Line 244: @@
 Moving on to command line setup - now that we have the files in place, we're going to create the database tables, insert some basic required data, and get the crons (scheduled scripts; primarily for scheduled news posts) working.
-On both run the following, letting each complete before the next one:
+Run the following, letting each complete before the next one:
   <pre>php artisan key:generate
 php artisan migrate</pre>

@@ Line 183: / Line 183: @@
 ====Social Media Platforms====
-As of [[Updating: to 2.0.0|2.0.0]], there are several options for platforms to use for account linking/verification. See [[:Category:Social Media Authentication|Category:Social Media Authentication]] for instructions for supported sites. Note that you will also need to enable these via config file later.
+As of [[Updating: to 2.0.0|2.0.0]], there are several options for platforms to use for account linking/verification. See [[:Category:Social Media Authentication|Category:Social Media Authentication]] for instructions for supported sites. Note that you will also need to enable these via config file later. Note that you must set up and enable '''at least one''' of these platforms for use for auth.
 ===.env===
@@ Line 237: / Line 237: @@
 </pre>
-Leave the APP_KEY blank, as it will be generated in a later step.
+Leave the APP_KEY blank, as it will be generated in a later step. Also make sure to add information for the platform(s) used for auth to the end as in the platform-specific instructions!
 Now, use an FTP client ([https://winscp.net/eng/index.php WinSCP] if following the recommendations) to upload this file to the www directory of your site. '''Note that this is the only file that should be added or modified this way; all other files <u>must</u> be modified locally and pushed to the server with git.'''

@@ Line 137: / Line 137: @@
 If set up correctly, the output log should display the message you wrote in post-update and show that the file was updated without errors.
-For a small but important tweak, we'll change the origin of our repository to point to the new site. This is demonstrated in Sourcetree, but should not be too much different in other clients.
+For a small but important tweak, we'll change the origin of our repository to point to the new site.
 #Checkout the site's master branch.

@@ Line 79: / Line 79: @@
 cd www
 git init</pre>
-Go back out and make a second directory named <pre>site_hub.git</pre> and init it as a bare repository.
+Go back out, make a second directory named site_hub.git, and init it as a bare repository.
- <pre>cd ..
+<pre>cd ..
 mkdir site_hub.git
 cd site_hub.git