README.md
[//]: #@corifeus-header
[![Build Status](https://travis-ci.org/patrikx3/ramdisk.svg?branch=master)](https://travis-ci.org/patrikx3/ramdisk) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/patrikx3/ramdisk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/patrikx3/ramdisk/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/patrikx3/ramdisk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/patrikx3/ramdisk/?branch=master)
[![NPM](https://nodei.co/npm/p3x-ramdisk.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/p3x-ramdisk/)
---
# RAM disk persistent with Systemd timer, service and suspend v1.0.500-224
This is an open source project. Just code. If you like this code, please add a star in GitHub and you really like, you can donate as well. Thanks you so much!
Given, I have my own server, with dynamic IP address, it could happen that the server for about max 5 minutes can not be reachable for the dynamic DNS or very rarely I backup with Clonzilla the SSD or something with the electricity (too much hoovering or cleaning - but I worked on it, so should not happen again), but for some reason, it is not reachable please hang on for 5-30 minutes and it will be back for sure.
All my domains (patrikx3.com and corifeus.com) could have errors right now, since I am developing in my free time and you can catch glitches, but usually it is stable (imagine updating everything always, which is weird).
### Node Version Requirement
```
>=8.9.0
```
### Built on Node
```
v9.3.0
```
The ```async``` and ```await``` keywords are required.
Install NodeJs:
https://nodejs.org/en/download/package-manager/
undefined
# Description
[//]: #@corifeus-header:end
# Install
```bash
sudo npm install -g p3x-ramdisk --unsafe-perm=true --allow-root
```
## IntelliJ Speed
Based on:
http://sheroz.com/pages/blog/improving-development-performance-moving-intellij-idea-cache-ramdisk.html
```text
After all these tricks I tried to open my current project with IntelliJ IDEA 12 …
Wow!!! It is fantastic! Works like a … sword!!!
Why sword?! I don’t know exactly. May be because of Darcula theme. This is just first thought what came to my mind seeing the overall results.
The Intellij IDEA 12 now works as a lightsaber sword, as a weapon of a Jedi Knight, which you can trust in Java world!
```
* Requires tmpfs, bash, fstab, rsync, memory :)
* Usually, all requirements of every Unix flavor are installed by default
* SystemD
* Service
* Timer
* Suspend
* RAM disk to HDD
* Linux, Unix, BSD, macOS
* Should might need some tuning, but the functions are there, I just only tested in Linux.
## Intel Optane
I think my ramdisk is faster. :) Ciao!!!
# Use case
Speed up IntelliJ and development Node. (Tons of files.)
The result is that the development is many folds faster. No waiting at all.
# Install
```text
patrikx3@workstation ~ $ p3x-ramdisk install --help
Usage: install [options] <uid>
Install a p3x-ramdisk
Options:
-h, --help output usage information
-r, --rampath [path] The path of the ram disk, default /home/$USERNAME/ramdisk
-p, --persistent [path] The path of the ram persistent, default /home/$USERNAME/ramdisk-persistent
-g, --gid [group] The gid, it you omit it is the current user
-t, --timer [minutes] The timer in minutes, minimum about 10 minutes, Default is 20 minutes, the best
-s, --size [megabytes] Ramdisk in size of megabytes, default is 4096 megabytes
```
# IMPORTANT
Trash is disabled in GNOME with p3x-ramdisk. It will ask for confirm to delete data.
You might have it in the previous save. It is possible to enable trash bin, but for me is not important now, so I disabled, memory is not cheap.
# Setup
**Use GitHub for info, NPM hides wide strings.**
https://github.com/patrikx3/ramdisk
```bash
# of course your data will never be deleted,
# double persistence (current, previouse, saves every 20 minutes)
# load on boot, plus at shutdown and suspend it saves
sudo npm install -g p3x-ramdisk --unsafe-perm=true --allow-root
# install
# if you need less/more memory, add -s 1024 or even more, 10GB is good :)
sudo p3x-ramdisk install $USERNAME
# Get the output, add to /etc/fstab
echo "tmpfs /home/patrikx3/ramdisk tmpfs gid=10000,uid=10000,size=4096M 0 0" | sudo tee -a /etc/fstab
sudo mount -a
# you should verify the ramdisk is existing now, you might have to reboot
# on linux it can show your settings, like below:
df -h
# if there is an error, you can
sudo p3x-ramdisk stop
# if all good
# STARTUP THE RAMDISK PERSISTENT
sudo p3x-ramdisk start
# you can work like here
# /home/$USERNAME/ramdisk/persistence/content
# SOME DEBUG
p3x-ramdisk watch
# to trigger a savs
p3x-ramdisk save
# you don't need usually to save
# the default is 20 minutes
# the systemd service saves on suspend and shutdown
# to stop the services
# removes sync, so the ramdisk files will be unavailable,
# only be in /home/username/ramdisk-persistent/current
sudo p3x-ramdisk stop
# your duplicate copies are
ls -all /home/$USERNAME/ramdisk-persistent/current/
ls -all /home/$USERNAME/ramdisk-persistent/previous/
# you are done
# the default use case is to speed up working with IntelliJ and my projects to ramdisk
# if you just want persistent folder and that's all
# there is a special folder, .p3x-ramdisk-link
# everything there is linked into /home/$USERNAME
# if there is nothing in .p3x-ramdisk-link
# no linking is. to test it, you might not need it.
```
## Linkin' in /home
```bash
### //LINKING - NOT REQUIRED
p3x-ramdisk save
sudo p3x-ramdisk stop
mkdir -p /home/$USERNAME/ramdisk-persistent/current/.p3x-ramdisk-link
cp -avr /home/$USERNAME/.IntelliJIdea2017.3 /home/$USERNAME/ramdisk-persistent/current/.p3x-ramdisk-link
# backup
mkdir -p /home/$USERNAME/backup
mv /home/$USERNAME/.IntelliJIdea2017.1 /home/username/backup/
# need to delete the originals, since they become symlinks
rm -rf /home/$USERNAME/.IntelliJIdea2017.1
sudo p3x-ramdisk start
### //LINKING:END
```
# Output
## Install
```text
patrikx3@laptop:~/ramdisk/persistence/content/.p3x-ramdisk-link/Projects/patrikx3/ramdisk$ sudo p3x-ramdisk install patrikx3 -s 6144
2017-05-08 00:30:08: terminal install
2017-05-08 00:30:08: terminal copy
2017-05-08 00:30:08: terminal suspend
2017-05-08 00:30:08: terminal reload services
2017-05-08 00:30:08: terminal install done
Settings: {
"rampath": "ramdisk",
"persistent": "ramdisk-persistent",
"uid": "patrikx3",
"uidNumber": 10000,
"gid": "patrikx3",
"timer": 20,
"size": "4096",
"home": "/home/patrikx3",
"script": "/home/patrikx3/.p3x-ramdisk"
}
Final commands:
--------------------------
1) You only have to do it once, if you haven't done it before
echo "tmpfs /home/patrikx3/ramdisk tmpfs gid=10000,uid=10000,size=4096M 0 0" | sudo tee -a /etc/fstab
sudo mount -a
--------------------------
2) verify that ramdisk is working, see it here
df -h
--------------------------
3) if everything is ok, start the persistent ramdisk
sudo p3x-ramdisk start
patrikx3@laptop:~/ramdisk/persistence/content/.p3x-ramdisk-link/Projects/patrikx3/ramdisk$
```
## Watching the RAM disk
```bash
p3x-ramdisk watch
```
```
Filesystem Size Used Avail Use% Mounted on
tmpfs 4,0G 2,0G 2,1G 50% /home/patrikx3/ramdisk
total used free shared buff/cache available
Mem: 31G 3,3G 18G 2,0G 9,8G 25G
Swap: 8,0G 0B 8,0G
Load: 2017-05-27 09:01:49 2017-05-27 09:01:56 0 minutes 7 seconds
Save: 2017-05-27 09:20:00 2017-05-27 09:20:16 0 minutes 16 seconds
2017-05-27 09:20:00: timer save, ramdisk to current
2017-05-27 09:20:00: timer save /home/patrikx3/ramdisk/persistence/content to /home/patrikx3/ramdisk-persistent/current
2017-05-27 09:20:16: timer saved
2017-05-27 09:20:16: timer save done
2017-05-27 09:20:16: timer 0 minutes 16 seconds
5/27/2017, 9:24:45 AM | Persistence 20 minutes | Watch 1 second
```
# LOGS
``` /home/username/ramdisk-persistent/ramdisk-persistent.log ```
``` /home/username/ramdisk-persistent/update-at-load.log ```
``` /home/username/ramdisk-persistent/update-at-save.log ```
## LOG info
```text
2017-05-06 02:57:37: boot loading
2017-05-06 02:57:37: boot load /home/patrikx3/ramdisk-persistent/current to /home/patrikx3/ramdisk/persistence/content
2017-05-06 02:57:47: boot loaded
2017-05-06 02:57:47: boot link
2017-05-06 02:57:47: boot link /home/patrikx3/ramdisk/persistence/content/.IntelliJIdea2017.1 to /home/patrikx3/.IntelliJIdea2017.1
2017-05-06 02:57:47: boot link /home/patrikx3/ramdisk/persistence/content/Projects to /home/patrikx3/Projects
2017-05-06 02:57:47: boot link done
2017-05-06 02:57:47: boot 0 minutes 10 seconds
2017-05-06 02:57:47: timer save
2017-05-06 02:57:47: timer save, current to previous
2017-05-06 02:57:47: timer save /home/patrikx3/ramdisk-persistent/current to /home/patrikx3/ramdisk-persistent/previous
2017-05-06 02:57:50: timer saved
2017-05-06 02:57:50: timer save, ramdisk to current
2017-05-06 02:57:50: timer save /home/patrikx3/ramdisk/persistence/content to /home/patrikx3/ramdisk-persistent/current
2017-05-06 02:57:53: timer saved
2017-05-06 02:57:53: timer save done
2017-05-06 02:57:53: timer 0 minutes 6 seconds
```
## LOG Update
```text
2017-05-06 03:31:51
2017-05-06 03:31:57
0 minutes 6 seconds
```
# Thunder ramdisk persistence
```text
patrikx3@workstation ~/ramdisk-persistent/current/.p3x-ramdisk-link $ ll
total 32
drwxr-xr-x 8 patrikx3 patrikx3 4096 May 7 13:04 ./
drwxr-xr-x 3 patrikx3 patrikx3 4096 May 7 13:02 ../
drwxr-xr-x 4 patrikx3 patrikx3 4096 Apr 25 17:51 .IntelliJIdea2017.1/
patrikx3@workstation ~/ramdisk-persistent/current/.p3x-ramdisk-link $
```
[//]: #@corifeus-footer
---
[**P3X-RAMDISK**](https://pages.corifeus.com/ramdisk) Build v1.0.500-224
[![Like Corifeus @ Facebook](https://img.shields.io/badge/LIKE-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software) [![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=LFRV89WPRMMVE&lc=HU&item_name=Patrik%20Laszlo&item_number=patrikx3¤cy_code=HUF&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact)
[//]: #@corifeus-footer:end