24 01 Install
Are0h edited this page 3 months ago

The Setup

For Blogging

If you’re using Fipamo on a server to host and serve, it doesn’t care what kind of web server you have. Just set up a reverse proxy so it knows where to find your site and hook it up to our domain. There are a couple examples below to get you started

Once that is done, grab a copy of the latest release or clone git clone https://code.playvicio.us/Are0h/Fipamo.git --branch beta-release your-folder (replace ‘your-folder’ with whatever you want) it to make it easier to update.

Go into the directory you dumped in and run npm install so it grabs all the stuff it needs to run. Once that process completes, run npm start and that will get everything up and running. Head to http://localhost:2314/@/dashboard locally or http://your-domain.whatever/@/dashboard if you installed it on a server and enter some basic info for the set up and you’re good go.

Up and running? Learn how to use Fipamo.

For Dev Collaboration

To contribute to Fipamo, you’re going to need to grab a copy of the develop branch. Do that with git clone https://code.playvicio.us/Are0h/Fipamo.git. Also make sure you have nodemon installed as that what the development branch useses to spark up the server and reset the server when changes are made. Run npm install -g nodemon and your all set.

Once you have a copy, jump into the directory and run npm install to grab everything the branch needs to run.

From here there are two commands that need to run to create the scripts and css assets that dashboard needs and monitor further changes to update to those assets when changes are made. The first is npm run watch. This will keep an eye on stylus and script edits and render those assets accordingly. The second is npm run dev and this will start up the server and monitor changes that are made to core functionality and restart the server when needed. Both of these scripts will run in the background while code edits are being made. To see those changes, go to http://localhost:2314/@/dashboard.

NOTE The default port for Fipamo is 2314 but it can be configured in site/settings.json. This requires an manual restart so run ‘npm stop’, change the port in the settings file and ‘npm start’ to start the site back up again and it will pick up on the new port settings. DO NOT FORGET TO MAKE THE CHANGE IN YOUR REVERSE PROXY CONFIG. IF YOU DON’T APACHE/NGINX WILL NOT KNOW WHERE THE SITE IS RUNNING AND WON’T BE SERVED. VERY IMPORTANT.

Reverse Proxy for NGINX

server {  
      listen 80;
      server_name yourcoolassdomain.com;
      client_max_body_size 20M //Change to whatever to limit/increase file upload size
      location / {  
           proxy_http_version 1.1;  
           proxy_set_header Upgrade $http_upgrade;  
           proxy_set_header Connection 'upgrade';  
           proxy_set_header Host $host;  
           proxy_cache_bypass $http_upgrade;  

Reverse Proxy for Apache

<VirtualHost *:80>
    ServerName yourcoolassdomain.org
    ProxyPreserveHost On
    ProxyPass "/" ""
    ProxyPassReverse "/" ""
    LimitRequestBody 16384

Also it is strongly recommened to set up a ssl certificate to protect yourself if your using Fipamo through a web server. Certbot makes this proces dead simple.

Updating Fipamo

When updating the first thing you need to do is to shut down the site. Fipamo comes with script to make this easy, so just to the directory where you installed Fipamo and type npm stop and the site will shut down.

There are two ways to update Fipamo. If you’re using git, you can just go into the directory where you set up your site and do a git pull to get the latest. If you’re not using git, just grab the latest release and replace your files.

Use either method to get the new stuff and then start the site back up again using npm start. Easy peasy, lemon squeezy.