diff --git a/404.html b/404.html index 9fdef9094..ed9b3bf97 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - + diff --git a/assets/js/19f79f7b.f4de5e9e.js b/assets/js/19f79f7b.fe682020.js similarity index 99% rename from assets/js/19f79f7b.f4de5e9e.js rename to assets/js/19f79f7b.fe682020.js index ec9960804..c688a0d34 100644 --- a/assets/js/19f79f7b.f4de5e9e.js +++ b/assets/js/19f79f7b.fe682020.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8489],{8816:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>g,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var o=n(5893),i=n(1151),s=n(3872);const r={title:"How to manage log files",hide_title:!0,slug:"how-to-manage-log-files",date:new Date("2023-10-27T12:00:00.000Z"),image:"./assets/managing-the-keystore.png?202311181211",description:"Learn how to rotate, compress the log files",category:"Tutorial",tags:["guide","logs"]},l=void 0,a={id:"Node Operators/how-to-manage-logfiles",title:"How to manage log files",description:"Learn how to rotate, compress the log files",source:"@site/guides/Node Operators/how-to-manage-logfiles.md",sourceDirName:"Node Operators",slug:"/Node Operators/how-to-manage-log-files",permalink:"/guides/Node Operators/how-to-manage-log-files",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/how-to-manage-logfiles.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"logs",permalink:"/guides/tags/logs"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"How to manage log files",hide_title:!0,slug:"how-to-manage-log-files",date:"2023-10-27T12:00:00.000Z",image:"./assets/managing-the-keystore.png?202311181211",description:"Learn how to rotate, compress the log files",category:"Tutorial",tags:["guide","logs"]},sidebar:"defaultSidebar",previous:{title:"Getting Started",permalink:"/guides/Node Operators/getting-started"},next:{title:"Managing the keystore",permalink:"/guides/Node Operators/managing-the-keystore"}},c={image:n(4110).Z},d=[{value:"Introduction",id:"introduction",level:2},{value:"Journal",id:"journal",level:2},{value:"Commands",id:"commands",level:3},{value:"Disk utilization checkup",id:"disk-utilization-checkup",level:4},{value:"Clearing logs manually",id:"clearing-logs-manually",level:4},{value:"Follow or tail logs of service",id:"follow-or-tail-logs-of-service",level:4},{value:"Show all service entries",id:"show-all-service-entries",level:4},{value:"Configuration file",id:"configuration-file",level:3},{value:"Create the directory and config file",id:"create-the-directory-and-config-file",level:3},{value:"Configuration settings",id:"configuration-settings",level:3},{value:"Logrotate",id:"logrotate",level:2},{value:"Prerequesite",id:"prerequesite",level:3},{value:"Explore the Configuration files",id:"explore-the-configuration-files",level:3},{value:"Create the Lightning logrotate configuration file",id:"create-the-lightning-logrotate-configuration-file",level:3},{value:"Lightning Configuration Settings",id:"lightning-configuration-settings",level:3},{value:"Cron job",id:"cron-job",level:3},{value:"Conclusion",id:"conclusion",level:2}];function h(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"How to manage log files",src:n(5407).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,o.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,o.jsx)(t.p,{children:"The Fleek Network node streams text messages to the standard output and error in Linux. Given that disk space is a limited resource for most systems, the number of text data can be a cause of concern. Managing the file sizes by means of rotation and compression can help."}),"\n",(0,o.jsx)(t.p,{children:"A conventional Fleek Network Service setup (as per the documentation and tool recommendations), have the text data stored in a special directory for storing logs called /var/log. The /var/log directory contains logs from various applications running on the operating system, the operating system itself, and others."}),"\n",(0,o.jsx)(t.p,{children:"For the purpose of storing network node operation logs, it defaults to the /var/log/lightning directory where the files output.log (stdout) and diagnostic.log (stderr) is located and accumulated. As the node runs, the size of the files increase, as it aggregates all the output generated by the Fleek Network service operations, such as info, errors, etc."}),"\n",(0,o.jsx)(t.p,{children:"A Node Operator can configure the system to rotate, compress, and set maximum size of these files to safeguard any concerns or issues that can get out of control, such as causing disk space to become full quickly."}),"\n",(0,o.jsxs)(t.p,{children:["In this guide, we'll look into some options available to manage the logs. First, we'll look into journald.conf which controls where to store journal data (the journal is a component of systemd that handles all the messages in a Systemd enabled system). Afterwards, we'll look into ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"Logrotate"})," an application to help us manage automatic rotation and compression of log files."]}),"\n",(0,o.jsx)(t.p,{children:"In essence, the journal and the logs duplicate the same information, and we want to make sure that we set measures to control it."}),"\n",(0,o.jsx)(t.h2,{id:"journal",children:"Journal"}),"\n",(0,o.jsxs)(t.p,{children:["Journal is a component of Systemd, a centralized location for all messages logged by different components in a systemd-enabled Linux system. The systemd journal will happily run in parallel with the standard type log files in ",(0,o.jsx)(t.code,{children:"/var/log/*"})," where the Fleek Network Systemd Unit Service outputs Standard Output and Standard Error in the location ",(0,o.jsx)(t.code,{children:"/var/log/lightning/*.log"}),"."]}),"\n",(0,o.jsxs)(t.p,{children:["Here, we are going to learn how to configure the ",(0,o.jsx)(t.code,{children:"journald.conf"})," service configuration file for the system-wide settings (meaning that it applies to all services), but firstly we're going to learn some commands to help us troubleshoot when necessary."]}),"\n",(0,o.jsx)(t.h3,{id:"commands",children:"Commands"}),"\n",(0,o.jsx)(t.h4,{id:"disk-utilization-checkup",children:"Disk utilization checkup"}),"\n",(0,o.jsx)(t.p,{children:"To check how much disk space is used by Systemd log files, run the command below:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --disk-usage\n"})}),"\n",(0,o.jsx)(t.p,{children:"It provides information of how much disk space is utilized by the log files in your system."}),"\n",(0,o.jsx)(t.h4,{id:"clearing-logs-manually",children:"Clearing logs manually"}),"\n",(0,o.jsxs)(t.p,{children:["The best way to clear log files is done automatically by the ",(0,o.jsx)(t.code,{children:"journald.conf"})," configuration file, discussed in ",(0,o.jsx)(t.a,{href:"#configuration-file",children:"Configuration file"}),". In the ideal world, you shouldn't have to manually delete the log files, but this can be useful to know about when troubleshooting."]}),"\n",(0,o.jsxs)(t.p,{children:["To ",(0,o.jsx)(t.code,{children:"flush"})," the log files run the command below:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --flush --rotate\nsudo journalctl --vacuum-time=1s\n"})}),"\n",(0,o.jsxs)(t.admonition,{type:"tip",children:[(0,o.jsx)(t.p,{children:"The flush and rotate flag is used, as vaccum-time only clears archived logs and not active ones. It'll flush:"}),(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"Move /run/log/journal to /var/log/journal"}),"\n",(0,o.jsx)(t.li,{children:"Rotate (this flag archives logs and retains it)"}),"\n"]}),(0,o.jsx)(t.p,{children:"Since it'll only keep the past 1-second-long files, it'll effectively clear everything."})]}),"\n",(0,o.jsx)(t.h4,{id:"follow-or-tail-logs-of-service",children:"Follow or tail logs of service"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u .service -f\n"})}),"\n",(0,o.jsx)(t.p,{children:"For example, for a conventional native install (if you haven't followed the conventions, make the appropriate tweaks to fit your needs)."}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u lightning.service -f\n"})}),"\n",(0,o.jsx)(t.p,{children:"The Docker service"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u docker-lightning.service -f\n"})}),"\n",(0,o.jsx)(t.h4,{id:"show-all-service-entries",children:"Show all service entries"}),"\n",(0,o.jsx)(t.p,{children:"Show all journal entries, which can be fairly long:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl\n"})}),"\n",(0,o.jsx)(t.h3,{id:"configuration-file",children:"Configuration file"}),"\n",(0,o.jsxs)(t.p,{children:["The default configuration file is located at ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"}),". This is the main file that journal reads the configuration from, for the system instances that are controlled by root."]}),"\n",(0,o.jsxs)(t.p,{children:["In addition to the main configuration file there are a few other locations that take higher precedence and override the main configuration file. To learn more about journald read ",(0,o.jsx)(t.a,{href:"https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#Options",children:"here"}),"."]}),"\n",(0,o.jsxs)(t.p,{children:["To keep the guide short we are going to use the main location ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"create-the-directory-and-config-file",children:"Create the directory and config file"}),"\n",(0,o.jsxs)(t.p,{children:["If the ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"})," file doesn't exist, create it by:"]}),"\n",(0,o.jsxs)(t.p,{children:["Create the ",(0,o.jsx)(t.code,{children:"journald.conf"})," file:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo touch /etc/systemd/journald.conf\n"})}),"\n",(0,o.jsx)(t.h3,{id:"configuration-settings",children:"Configuration settings"}),"\n",(0,o.jsx)(t.p,{children:"The Systemd provides many options for you to manage the log files and by combining these parameters you can limit the disk space used by the journal files."}),"\n",(0,o.jsxs)(t.p,{children:["A list of the available options are ",(0,o.jsx)(t.a,{href:"https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#Options",children:"here"}),"."]}),"\n",(0,o.jsx)(t.p,{children:"Here is a quick description of the options we're going to use for our example:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Storage"}),", controls where to store journal data"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"SystemMaxUse"}),", specifies the maximum disk space that can be used by the journal in persistent storage"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"SystemMaxFileSize"}),", controls how large individual journal files can grow to in persistent storage before being rotated"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"RuntimeMaxUse"}),", control how much disk space the journal may use up at most"]}),"\n"]}),"\n",(0,o.jsxs)(t.p,{children:["You should open the ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"})," file in your favorite text editor and put:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-toml",children:"[Journal]\nStorage=persistent\nSystemMaxUse=1G\nSystemMaxFileSize=100M\nRuntimeMaxUse=100M\n"})}),"\n",(0,o.jsx)(t.p,{children:"Here, we set 1G and 100M, which means 1 Gigabyte and 100 Megabytes. You can also use K for Kbytes, amongst others."}),"\n",(0,o.jsx)(t.p,{children:"After the changes, you have to restart the journald after updating the file. To restart use the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo systemctl restart systemd-journald\n"})}),"\n",(0,o.jsx)(t.p,{children:"You can verify the integrity of the log files by running:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --verify\n"})}),"\n",(0,o.jsx)(t.h2,{id:"logrotate",children:"Logrotate"}),"\n",(0,o.jsx)(t.p,{children:"Logrotate is a tool to manage the log files created by a system processes. It can automatically compress, rename, remove logs and more for your convenience and save your system's resources. Log files can be handled timely, or when it grows too large."}),"\n",(0,o.jsx)(t.h3,{id:"prerequesite",children:"Prerequesite"}),"\n",(0,o.jsx)(t.p,{children:"The logrotate tools is available by default on Ubuntu."}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"We're using Ubuntu for our guide to keep it simple. If you are using a different and support operating system make sure you install Logrotate before proceeding."})}),"\n",(0,o.jsx)(t.p,{children:"You can check if logrotate is installed by executing:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"logrotate --version\n"})}),"\n",(0,o.jsx)(t.p,{children:"At the time this guide was written, we got the following output:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"logrotate 3.21.0\n\n Default mail command: /usr/bin/mail\n Default compress command: /bin/gzip\n Default uncompress command: /bin/gunzip\n Default compress extension: .gz\n Default state file path: /var/lib/logrotate/status\n ACL support: yes\n SELinux support: yes\n"})}),"\n",(0,o.jsx)(t.p,{children:"If you run an earlier or older version, changes or tweaks might apply."}),"\n",(0,o.jsx)(t.h3,{id:"explore-the-configuration-files",children:"Explore the Configuration files"}),"\n",(0,o.jsx)(t.p,{children:"The configuration files we'll be exploring today are found in the following locations in Ubuntu:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"/etc/logrotate.conf"}),", is the main configuration settings file. It includes the statement to pull in configuration files from other directories, e.g. the ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d"})]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"/etc/logrotate.d/"}),", a directory where packages drop log rotation information"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"We use Ubuntu for our guide, if you are on a different distro, you have to determine the file configuration file locations"})}),"\n",(0,o.jsxs)(t.p,{children:["The content of the file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"})," should be similar to:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:'# see "man logrotate" for details\n\n# global options do not affect preceding include directives\n\n# rotate log files weekly\nweekly\n\n# use the adm group by default, since this is the owning group\n# of /var/log/.\nsu root adm\n\n# keep 4 weeks worth of backlogs\nrotate 4\n\n# create new (empty) log files after rotating old ones\ncreate\n\n# use date as a suffix of the rotated file\n#dateext\n\n# uncomment this if you want your log files compressed\n#compress\n\n# packages drop log rotation information into this directory\ninclude /etc/logrotate.d\n\n# system-specific logs may also be configured here.\n'})}),"\n",(0,o.jsx)(t.p,{children:"The configuration settings if anything like the above, tell us that the rotation happens weekly, keeping 4 weeks worth of backlogs, etc."}),"\n",(0,o.jsxs)(t.p,{children:["To learn more about other configuration options consult the ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"logrotate manual page"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"create-the-lightning-logrotate-configuration-file",children:"Create the Lightning logrotate configuration file"}),"\n",(0,o.jsx)(t.p,{children:"Let's create a Logrotate configuration file for Fleek Network Lightning Service. Create the file by running the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo touch /etc/logrotate.d/lightning\n"})}),"\n",(0,o.jsx)(t.h3,{id:"lightning-configuration-settings",children:"Lightning Configuration Settings"}),"\n",(0,o.jsxs)(t.p,{children:["Open the recently created file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d/lightning"})," in your favorite text editor."]}),"\n",(0,o.jsx)(t.p,{children:"Add the following lines to the file:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/var/log/lightning/*.log {\n rotate 5\n daily\n size 50M\n notifempty\n compress\n}\n"})}),"\n",(0,o.jsx)(t.p,{children:"Remember to save the file before exiting the text editor. You can test the configuration file by running the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo logrotate /etc/logrotate.conf --debug\n"})}),"\n",(0,o.jsxs)(t.p,{children:["The configuration file above declares that for the log files in the ",(0,o.jsx)(t.code,{children:"/var/log/lightning"})," directory, the log files are rotated 5 times daily before being removed, as long they grow bigger than 50 megabytes in file size or empty. Old versions of log files are compressed with gzip."]}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsxs)(t.p,{children:["Bear in mind that this configuration file also inherit the default behavior, e.g. the ",(0,o.jsx)(t.code,{children:"create"})," as set in the main configuration file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"}),"."]})}),"\n",(0,o.jsxs)(t.p,{children:["Feel free to customize the settings to your liking by checking the documentation in the ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"logrotate manual page"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"cron-job",children:"Cron job"}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsx)(t.p,{children:"Depending on the operating system, you have to set up a cron job to execute logrotate with the configuration file daily. Since we are using Ubuntu for our example, a daily cron job runner is already set up for us. If you are on a different Distro/OS make the required amends."})}),"\n",(0,o.jsxs)(t.p,{children:["Verify that the ",(0,o.jsx)(t.code,{children:"/etc/cron.daily/logrotate"})," exists and includes the execution of ",(0,o.jsx)(t.code,{children:"logrotate"})," with the configuration argument ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"}),"."]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/usr/sbin/logrotate /etc/logrotate.conf\n"})}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"If you have modified the location of the binary or main configuration file, make sure this is set correctly to your custom locations."})}),"\n",(0,o.jsxs)(t.p,{children:["To summarize, the ",(0,o.jsx)(t.code,{children:"logrotate /etc/logrotate.conf"})," is executed and as logrotate.conf goes through its list of commands, it calls ",(0,o.jsx)(t.code,{children:"include /etc/logrotate.d"}),". It means that any scripts in ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d"})," are executed, such as the ",(0,o.jsx)(t.a,{href:"#lightning-configuration-settings",children:"Lightning Configuration Settings"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,o.jsx)(t.p,{children:"The guide starts by warning us about the stream text messages that the Fleek Network emits by default. As the text data is aggregated and stored in the file system it can lead to fill up the limited available disk space quickly, causing issues to the operation of the system."}),"\n",(0,o.jsx)(t.p,{children:"To help control it, the journald is introduced, by explaining its role as a centralized message system, that runs alongside the application logs. Then, have it configured to limit the maximum file size, amongst other system-wide settings."}),"\n",(0,o.jsx)(t.p,{children:"Finally, logrotate is discussed in helping us manage the Fleek Network Lightning application log files by setting it to automatically compress, rename, remove logs for the system admin convenience and saving system's resources."}),"\n",(0,o.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>i});n(7294);var o=n(5893);const i=e=>{let{image:t,name:n,title:i,url:s,communityMember:r=!1}=e;return(0,o.jsx)("section",{className:"author_card",children:(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"avatar",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:n,children:(0,o.jsx)("img",{src:t,alt:n})})}),(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"name",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:n,children:n})}),(0,o.jsx)("span",{className:"title",children:i}),(0,o.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,o.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},4110:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},5407:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/how-to-manage-log-files-be3f38ea329523fb5ec346ee98946dbe.png"},1151:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>r});var o=n(7294);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8489],{8816:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>g,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var o=n(5893),i=n(1151),s=n(3872);const r={title:"How to manage log files",hide_title:!0,slug:"how-to-manage-log-files",date:new Date("2023-10-27T12:00:00.000Z"),image:"./assets/managing-the-keystore.png?202311181211",description:"Learn how to rotate, compress the log files",category:"Tutorial",tags:["guide","logs"]},l=void 0,a={id:"Node Operators/how-to-manage-logfiles",title:"How to manage log files",description:"Learn how to rotate, compress the log files",source:"@site/guides/Node Operators/how-to-manage-logfiles.md",sourceDirName:"Node Operators",slug:"/Node Operators/how-to-manage-log-files",permalink:"/guides/Node Operators/how-to-manage-log-files",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/how-to-manage-logfiles.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"logs",permalink:"/guides/tags/logs"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"How to manage log files",hide_title:!0,slug:"how-to-manage-log-files",date:"2023-10-27T12:00:00.000Z",image:"./assets/managing-the-keystore.png?202311181211",description:"Learn how to rotate, compress the log files",category:"Tutorial",tags:["guide","logs"]},sidebar:"defaultSidebar",previous:{title:"Getting Started",permalink:"/guides/Node Operators/getting-started"},next:{title:"Managing the keystore",permalink:"/guides/Node Operators/managing-the-keystore"}},c={image:n(4110).Z},d=[{value:"Introduction",id:"introduction",level:2},{value:"Journal",id:"journal",level:2},{value:"Commands",id:"commands",level:3},{value:"Disk utilization checkup",id:"disk-utilization-checkup",level:4},{value:"Clearing logs manually",id:"clearing-logs-manually",level:4},{value:"Follow or tail logs of service",id:"follow-or-tail-logs-of-service",level:4},{value:"Show all service entries",id:"show-all-service-entries",level:4},{value:"Configuration file",id:"configuration-file",level:3},{value:"Create the directory and config file",id:"create-the-directory-and-config-file",level:3},{value:"Configuration settings",id:"configuration-settings",level:3},{value:"Logrotate",id:"logrotate",level:2},{value:"Prerequesite",id:"prerequesite",level:3},{value:"Explore the Configuration files",id:"explore-the-configuration-files",level:3},{value:"Create the Lightning logrotate configuration file",id:"create-the-lightning-logrotate-configuration-file",level:3},{value:"Lightning Configuration Settings",id:"lightning-configuration-settings",level:3},{value:"Cron job",id:"cron-job",level:3},{value:"Conclusion",id:"conclusion",level:2}];function h(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:(0,o.jsx)(t.img,{alt:"How to manage log files",src:n(5407).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,o.jsx)(t.h2,{id:"introduction",children:"Introduction"}),"\n",(0,o.jsx)(t.p,{children:"The Fleek Network node streams text messages to the standard output and error in Linux. Given that disk space is a limited resource for most systems, the number of text data can be a cause of concern. Managing the file sizes by means of rotation and compression can help."}),"\n",(0,o.jsx)(t.p,{children:"A conventional Fleek Network Service setup (as per the documentation and tool recommendations), have the text data stored in a special directory for storing logs called /var/log. The /var/log directory contains logs from various applications running on the operating system, the operating system itself, and others."}),"\n",(0,o.jsx)(t.p,{children:"For the purpose of storing network node operation logs, it defaults to the /var/log/lightning directory where the files output.log (stdout) and diagnostic.log (stderr) is located and accumulated. As the node runs, the size of the files increase, as it aggregates all the output generated by the Fleek Network service operations, such as info, errors, etc."}),"\n",(0,o.jsx)(t.p,{children:"A Node Operator can configure the system to rotate, compress, and set maximum size of these files to safeguard any concerns or issues that can get out of control, such as causing disk space to become full quickly."}),"\n",(0,o.jsxs)(t.p,{children:["In this guide, we'll look into some options available to manage the logs. First, we'll look into journald.conf which controls where to store journal data (the journal is a component of systemd that handles all the messages in a Systemd enabled system). Afterwards, we'll look into ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"Logrotate"})," an application to help us manage automatic rotation and compression of log files."]}),"\n",(0,o.jsx)(t.p,{children:"In essence, the journal and the logs duplicate the same information, and we want to make sure that we set measures to control it."}),"\n",(0,o.jsx)(t.h2,{id:"journal",children:"Journal"}),"\n",(0,o.jsxs)(t.p,{children:["Journal is a component of Systemd, a centralized location for all messages logged by different components in a systemd-enabled Linux system. The systemd journal will happily run in parallel with the standard type log files in ",(0,o.jsx)(t.code,{children:"/var/log/*"})," where the Fleek Network Systemd Unit Service outputs Standard Output and Standard Error in the location ",(0,o.jsx)(t.code,{children:"/var/log/lightning/*.log"}),"."]}),"\n",(0,o.jsxs)(t.p,{children:["Here, we are going to learn how to configure the ",(0,o.jsx)(t.code,{children:"journald.conf"})," service configuration file for the system-wide settings (meaning that it applies to all services), but firstly we're going to learn some commands to help us troubleshoot when necessary."]}),"\n",(0,o.jsx)(t.h3,{id:"commands",children:"Commands"}),"\n",(0,o.jsx)(t.h4,{id:"disk-utilization-checkup",children:"Disk utilization checkup"}),"\n",(0,o.jsx)(t.p,{children:"To check how much disk space is used by Systemd log files, run the command below:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --disk-usage\n"})}),"\n",(0,o.jsx)(t.p,{children:"It provides information of how much disk space is utilized by the log files in your system."}),"\n",(0,o.jsx)(t.h4,{id:"clearing-logs-manually",children:"Clearing logs manually"}),"\n",(0,o.jsxs)(t.p,{children:["The best way to clear log files is done automatically by the ",(0,o.jsx)(t.code,{children:"journald.conf"})," configuration file, discussed in ",(0,o.jsx)(t.a,{href:"#configuration-file",children:"Configuration file"}),". In the ideal world, you shouldn't have to manually delete the log files, but this can be useful to know about when troubleshooting."]}),"\n",(0,o.jsxs)(t.p,{children:["To ",(0,o.jsx)(t.code,{children:"flush"})," the log files run the command below:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --flush --rotate\nsudo journalctl --vacuum-time=1s\n"})}),"\n",(0,o.jsxs)(t.admonition,{type:"tip",children:[(0,o.jsx)(t.p,{children:"The flush and rotate flag is used, as vaccum-time only clears archived logs and not active ones. It'll flush:"}),(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsx)(t.li,{children:"Move /run/log/journal to /var/log/journal"}),"\n",(0,o.jsx)(t.li,{children:"Rotate (this flag archives logs and retains it)"}),"\n"]}),(0,o.jsx)(t.p,{children:"Since it'll only keep the past 1-second-long files, it'll effectively clear everything."})]}),"\n",(0,o.jsx)(t.h4,{id:"follow-or-tail-logs-of-service",children:"Follow or tail logs of service"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u .service -f\n"})}),"\n",(0,o.jsx)(t.p,{children:"For example, for a conventional native install (if you haven't followed the conventions, make the appropriate tweaks to fit your needs)."}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u lightning.service -f\n"})}),"\n",(0,o.jsx)(t.p,{children:"The Docker service"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl -u docker-lightning.service -f\n"})}),"\n",(0,o.jsx)(t.h4,{id:"show-all-service-entries",children:"Show all service entries"}),"\n",(0,o.jsx)(t.p,{children:"Show all journal entries, which can be fairly long:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl\n"})}),"\n",(0,o.jsx)(t.h3,{id:"configuration-file",children:"Configuration file"}),"\n",(0,o.jsxs)(t.p,{children:["The default configuration file is located at ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"}),". This is the main file that journal reads the configuration from, for the system instances that are controlled by root."]}),"\n",(0,o.jsxs)(t.p,{children:["In addition to the main configuration file there are a few other locations that take higher precedence and override the main configuration file. To learn more about journald read ",(0,o.jsx)(t.a,{href:"https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#Options",children:"here"}),"."]}),"\n",(0,o.jsxs)(t.p,{children:["To keep the guide short we are going to use the main location ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"create-the-directory-and-config-file",children:"Create the directory and config file"}),"\n",(0,o.jsxs)(t.p,{children:["If the ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"})," file doesn't exist, create it by:"]}),"\n",(0,o.jsxs)(t.p,{children:["Create the ",(0,o.jsx)(t.code,{children:"journald.conf"})," file:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo touch /etc/systemd/journald.conf\n"})}),"\n",(0,o.jsx)(t.h3,{id:"configuration-settings",children:"Configuration settings"}),"\n",(0,o.jsx)(t.p,{children:"The Systemd provides many options for you to manage the log files and by combining these parameters you can limit the disk space used by the journal files."}),"\n",(0,o.jsxs)(t.p,{children:["A list of the available options are ",(0,o.jsx)(t.a,{href:"https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#Options",children:"here"}),"."]}),"\n",(0,o.jsx)(t.p,{children:"Here is a quick description of the options we're going to use for our example:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"Storage"}),", controls where to store journal data"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"SystemMaxUse"}),", specifies the maximum disk space that can be used by the journal in persistent storage"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"SystemMaxFileSize"}),", controls how large individual journal files can grow to in persistent storage before being rotated"]}),"\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.strong,{children:"RuntimeMaxUse"}),", control how much disk space the journal may use up at most"]}),"\n"]}),"\n",(0,o.jsxs)(t.p,{children:["You should open the ",(0,o.jsx)(t.code,{children:"/etc/systemd/journald.conf"})," file in your favorite text editor and put:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-toml",children:"[Journal]\nStorage=persistent\nSystemMaxUse=1G\nSystemMaxFileSize=100M\nRuntimeMaxUse=100M\n"})}),"\n",(0,o.jsx)(t.p,{children:"Here, we set 1G and 100M, which means 1 Gigabyte and 100 Megabytes. You can also use K for Kbytes, amongst others."}),"\n",(0,o.jsx)(t.p,{children:"After the changes, you have to restart the journald after updating the file. To restart use the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo systemctl restart systemd-journald\n"})}),"\n",(0,o.jsx)(t.p,{children:"You can verify the integrity of the log files by running:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo journalctl --verify\n"})}),"\n",(0,o.jsx)(t.h2,{id:"logrotate",children:"Logrotate"}),"\n",(0,o.jsx)(t.p,{children:"Logrotate is a tool to manage the log files created by a system processes. It can automatically compress, rename, remove logs and more for your convenience and save your system's resources. Log files can be handled timely, or when it grows too large."}),"\n",(0,o.jsx)(t.h3,{id:"prerequesite",children:"Prerequesite"}),"\n",(0,o.jsx)(t.p,{children:"The logrotate tools is available by default on Ubuntu."}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"We're using Ubuntu for our guide to keep it simple. If you are using a different and support operating system make sure you install Logrotate before proceeding."})}),"\n",(0,o.jsx)(t.p,{children:"You can check if logrotate is installed by executing:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"logrotate --version\n"})}),"\n",(0,o.jsx)(t.p,{children:"At the time this guide was written, we got the following output:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"logrotate 3.21.0\n\n Default mail command: /usr/bin/mail\n Default compress command: /bin/gzip\n Default uncompress command: /bin/gunzip\n Default compress extension: .gz\n Default state file path: /var/lib/logrotate/status\n ACL support: yes\n SELinux support: yes\n"})}),"\n",(0,o.jsx)(t.p,{children:"If you run an earlier or older version, changes or tweaks might apply."}),"\n",(0,o.jsx)(t.h3,{id:"explore-the-configuration-files",children:"Explore the Configuration files"}),"\n",(0,o.jsx)(t.p,{children:"The configuration files we'll be exploring today are found in the following locations in Ubuntu:"}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"/etc/logrotate.conf"}),", is the main configuration settings file. It includes the statement to pull in configuration files from other directories, e.g. the ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d"})]}),"\n"]}),"\n",(0,o.jsxs)(t.li,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"/etc/logrotate.d/"}),", a directory where packages drop log rotation information"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"We use Ubuntu for our guide, if you are on a different distro, you have to determine the file configuration file locations"})}),"\n",(0,o.jsxs)(t.p,{children:["The content of the file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"})," should be similar to:"]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:'# see "man logrotate" for details\n\n# global options do not affect preceding include directives\n\n# rotate log files weekly\nweekly\n\n# use the adm group by default, since this is the owning group\n# of /var/log/.\nsu root adm\n\n# keep 4 weeks worth of backlogs\nrotate 4\n\n# create new (empty) log files after rotating old ones\ncreate\n\n# use date as a suffix of the rotated file\n#dateext\n\n# uncomment this if you want your log files compressed\n#compress\n\n# packages drop log rotation information into this directory\ninclude /etc/logrotate.d\n\n# system-specific logs may also be configured here.\n'})}),"\n",(0,o.jsx)(t.p,{children:"The configuration settings if anything like the above, tell us that the rotation happens weekly, keeping 4 weeks worth of backlogs, etc."}),"\n",(0,o.jsxs)(t.p,{children:["To learn more about other configuration options consult the ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"logrotate manual page"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"create-the-lightning-logrotate-configuration-file",children:"Create the Lightning logrotate configuration file"}),"\n",(0,o.jsx)(t.p,{children:"Let's create a Logrotate configuration file for Fleek Network Lightning Service. Create the file by running the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo touch /etc/logrotate.d/lightning\n"})}),"\n",(0,o.jsx)(t.h3,{id:"lightning-configuration-settings",children:"Lightning Configuration Settings"}),"\n",(0,o.jsxs)(t.p,{children:["Open the recently created file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d/lightning"})," in your favorite text editor."]}),"\n",(0,o.jsx)(t.p,{children:"Add the following lines to the file:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/var/log/lightning/*.log {\n rotate 5\n daily\n size 50M\n notifempty\n compress\n}\n"})}),"\n",(0,o.jsx)(t.p,{children:"Remember to save the file before exiting the text editor. You can test the configuration file by running the command:"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"sudo logrotate /etc/logrotate.conf --debug\n"})}),"\n",(0,o.jsxs)(t.p,{children:["The configuration file above declares that for the log files in the ",(0,o.jsx)(t.code,{children:"/var/log/lightning"})," directory, the log files are rotated 5 times daily before being removed, as long they grow bigger than 50 megabytes in file size or empty. Old versions of log files are compressed with gzip."]}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsxs)(t.p,{children:["Bear in mind that this configuration file also inherit the default behavior, e.g. the ",(0,o.jsx)(t.code,{children:"create"})," as set in the main configuration file ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"}),"."]})}),"\n",(0,o.jsxs)(t.p,{children:["Feel free to customize the settings to your liking by checking the documentation in the ",(0,o.jsx)(t.a,{href:"https://linux.die.net/man/8/logrotate",children:"logrotate manual page"}),"."]}),"\n",(0,o.jsx)(t.h3,{id:"cron-job",children:"Cron job"}),"\n",(0,o.jsx)(t.admonition,{type:"note",children:(0,o.jsx)(t.p,{children:"Depending on the operating system, you have to set up a cron job to execute logrotate with the configuration file daily. Since we are using Ubuntu for our example, a daily cron job runner is already set up for us. If you are on a different Distro/OS make the required amends."})}),"\n",(0,o.jsxs)(t.p,{children:["Verify that the ",(0,o.jsx)(t.code,{children:"/etc/cron.daily/logrotate"})," exists and includes the execution of ",(0,o.jsx)(t.code,{children:"logrotate"})," with the configuration argument ",(0,o.jsx)(t.code,{children:"/etc/logrotate.conf"}),"."]}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{children:"/usr/sbin/logrotate /etc/logrotate.conf\n"})}),"\n",(0,o.jsx)(t.admonition,{type:"tip",children:(0,o.jsx)(t.p,{children:"If you have modified the location of the binary or main configuration file, make sure this is set correctly to your custom locations."})}),"\n",(0,o.jsxs)(t.p,{children:["To summarize, the ",(0,o.jsx)(t.code,{children:"logrotate /etc/logrotate.conf"})," is executed and as logrotate.conf goes through its list of commands, it calls ",(0,o.jsx)(t.code,{children:"include /etc/logrotate.d"}),". It means that any scripts in ",(0,o.jsx)(t.code,{children:"/etc/logrotate.d"})," are executed, such as the ",(0,o.jsx)(t.a,{href:"#lightning-configuration-settings",children:"Lightning Configuration Settings"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,o.jsx)(t.p,{children:"The guide starts by warning us about the stream text messages that the Fleek Network emits by default. As the text data is aggregated and stored in the file system it can lead to fill up the limited available disk space quickly, causing issues to the operation of the system."}),"\n",(0,o.jsx)(t.p,{children:"To help control it, the journald is introduced, by explaining its role as a centralized message system, that runs alongside the application logs. Then, have it configured to limit the maximum file size, amongst other system-wide settings."}),"\n",(0,o.jsx)(t.p,{children:"Finally, logrotate is discussed in helping us manage the Fleek Network Lightning application log files by setting it to automatically compress, rename, remove logs for the system admin convenience and saving system's resources."}),"\n",(0,o.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>i});n(7294);var o=n(5893);const i=e=>{let{image:t,name:n,title:i,url:s,communityMember:r=!1}=e;return(0,o.jsx)("section",{className:"author_card",children:(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"avatar",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:n,children:(0,o.jsx)("img",{src:t,alt:n})})}),(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"name",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:n,children:n})}),(0,o.jsx)("span",{className:"title",children:i}),(0,o.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,o.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},4110:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},5407:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/how-to-manage-log-files-be3f38ea329523fb5ec346ee98946dbe.png"},1151:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>r});var o=n(7294);const i={},s=o.createContext(i);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1c14429f.cb58d9d4.js b/assets/js/1c14429f.85e85158.js similarity index 99% rename from assets/js/1c14429f.cb58d9d4.js rename to assets/js/1c14429f.85e85158.js index c0bd07f3b..0dabe36df 100644 --- a/assets/js/1c14429f.cb58d9d4.js +++ b/assets/js/1c14429f.85e85158.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2702],{5894:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>h});var i=t(5893),o=t(1151),s=t(3872),r=t(3183);const a={template:"post",draft:!1,hide_title:!0,title:"Getting Started",slug:"getting-started",date:new Date("2023-08-31T23:00:00.000Z"),image:"./assets/getting-started.png?202311181211",canonical:"",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",category:"Tutorial",tags:["Edge computing","Guide","Getting Started"]},l=void 0,d={id:"Node Operators/getting-started-guide",title:"Getting Started",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",source:"@site/guides/Node Operators/getting-started-guide.md",sourceDirName:"Node Operators",slug:"/Node Operators/getting-started",permalink:"/guides/Node Operators/getting-started",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/getting-started-guide.md",tags:[{label:"Edge computing",permalink:"/guides/tags/edge-computing"},{label:"Guide",permalink:"/guides/tags/guide"},{label:"Getting Started",permalink:"/guides/tags/getting-started"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{template:"post",draft:!1,hide_title:!0,title:"Getting Started",slug:"getting-started",date:"2023-08-31T23:00:00.000Z",image:"./assets/getting-started.png?202311181211",canonical:"",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",category:"Tutorial",tags:["Edge computing","Guide","Getting Started"]},sidebar:"defaultSidebar",previous:{title:"About guides",permalink:"/guides/"},next:{title:"How to manage log files",permalink:"/guides/Node Operators/how-to-manage-log-files"}},c={image:t(3483).Z},h=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Need a quick Fleek Network TL;DR?",id:"need-a-quick-fleek-network-tldr",level:2},{value:"Why is Fleek Network needed?",id:"why-is-fleek-network-needed",level:2},{value:"How Does Fleek Network Work?",id:"how-does-fleek-network-work",level:2},{value:"Running a Node",id:"running-a-node",level:2},{value:"Clone the source code",id:"clone-the-source-code",level:3},{value:"Dependencies",id:"dependencies",level:3},{value:"Build",id:"build",level:3},{value:"Node Launch",id:"node-launch",level:3},{value:"Health check",id:"health-check",level:3},{value:"Next steps",id:"next-steps",level:2},{value:"Conclusion",id:"conclusion",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Getting started guide",src:t(7860).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"For this guide, we\u2019ll have a simple look into how Fleek Network works in its current development phase and briefly share some of the core concepts like spinning up a node."}),"\n",(0,i.jsx)(n.p,{children:"For those seeking advanced knowledge:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Read our ",(0,i.jsx)(n.a,{href:"/docs/whitepaper",children:"whitepaper"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["Check out ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"our open-source code"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["If you find any typos in our documentation, feel free to ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"provide us feedback"})," or contribute by opening a PR in our repository ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/fleek-network-docs/",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Git"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"need-a-quick-fleek-network-tldr",children:"Need a quick Fleek Network TL;DR?"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network is an open-source edge computing platform to accelerate the development and execution of the next generation of web services."}),"\n",(0,i.jsx)(n.p,{children:"The system is built on a distributed network of nodes, where services run within a fair and incentivized ecosystem constituted by an open community of developers and operators. It relies on blockchain technology at its core, allowing governance and token rewards as incentives for participation in serving the network."}),"\n",(0,i.jsx)(n.p,{children:"Made by an open community that's free to operate nodes or build services without the need for approvals, permissions, or intermediaries. Or simply, consume Fleek Network resources on demand, from anywhere, provided by services running on the edge."}),"\n",(0,i.jsx)(n.p,{children:"Applications, platforms and protocols build and utilize decentralized services on the Fleek Network to optimize performance and reduce dependency on typical centralized cloud providers and corporate infrastructure."}),"\n",(0,i.jsx)(n.p,{children:"Developers can build faster and launch better products by offloading parts of the development stack to the edge to focus on core features for the value proposition of the services being developed."}),"\n",(0,i.jsxs)(n.p,{children:["To get started, install a Network Node in a ",(0,i.jsx)(n.a,{href:"/docs/node/requirements",children:"supported"})," Linux server, such as Debian or Ubuntu (latest) by utilizing our simple ",(0,i.jsx)(n.a,{href:"/docs/node/install#assisted-installer",children:"assisted installer"})," to help onboard as quickly as possible."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"Our network is open to everyone, so you're more than welcome to join us anytime without any restrictions, permission or formalities. We'd be happy to have you as part of our community!"})}),"\n",(0,i.jsx)(n.p,{children:"Once connected to the server, open a terminal window and execute the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,i.jsx)(n.p,{children:"Follow the install assistant recommendations to have the node ready without hassle and as quickly as possible."}),"\n",(0,i.jsx)(n.h2,{id:"why-is-fleek-network-needed",children:"Why is Fleek Network needed?"}),"\n",(0,i.jsx)(n.p,{children:"Web3 products typically rely on centralized cloud infrastructure, which is vulnerable to attacks as computation and data can be easily manipulated to suit business goals. However, blockchain technology has paved the way for a new era of decentralized cloud computing and data storage. The Fleek Network offers a sustainable alternative to traditional centralized architectures, providing a secure, transparent, and accessible decentralized edge computing future for everyone."}),"\n",(0,i.jsx)(n.h2,{id:"how-does-fleek-network-work",children:"How Does Fleek Network Work?"}),"\n",(0,i.jsx)(n.p,{children:"When a client requests a service, the protocol determines the best route to the nodes where the service replicas and workload are allocated."}),"\n",(0,i.jsx)(n.p,{children:"Once the computation is successful, the data streaming routes to the client. On-client request fulfillment, a proof of delivery is generated containing cryptographically secured metadata about the original request, any parts involved and the resources consumed."}),"\n",(0,i.jsx)(n.p,{children:"The Delivery Acknowledgements are stored locally in the participating node memory pools, rolled up to the protocol consensus consistently throughout the Epoch. This agreement is formed by a random committee of any healthy Nodes that use the information provided to reward the Nodes fairly."}),"\n",(0,i.jsx)(n.h2,{id:"running-a-node",children:"Running a Node"}),"\n",(0,i.jsxs)(n.p,{children:["A Fleek Network node can be built and run on your machine. It\u2019s an ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"open-source project"})," and is open for contributions."]}),"\n",(0,i.jsx)(n.p,{children:"The project is written with Rust, a general-purpose programming language that you need to have installed in advance to be able to follow the current guide."}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To set up Rust, packages and library dependencies can be tricky. The quickest is to visit the ",(0,i.jsx)(n.a,{href:"https://rustup.rs/",children:"rustup.rs"}),". Alternatively, if you haven't already, the build section has a ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document to help."]})}),"\n",(0,i.jsx)(n.h3,{id:"clone-the-source-code",children:"Clone the source code"}),"\n",(0,i.jsx)(n.p,{children:"We\u2019ll clone the repository locally, build it and interact with the node through the binary or the HTTP JSON-RPC API with a client like cURL, but you can use a GUI (Postman, Insomnia, amongst others) if you prefer."}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsx)(n.p,{children:"The ~/fleek-network/lightning or $HOME/fleek-network/lightning directory is the default or recommended location to store the repository. If you like to follow conventions, then is best to stick with the recommendation, to avoid confusion and make it easier to follow our documentation."})}),"\n",(0,i.jsxs)(n.p,{children:["Start by cloning the repository located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"https://github.com/fleek-network/lightning"})]}),"\n",(0,i.jsx)(r.ZP,{}),"\n",(0,i.jsx)(n.p,{children:"Once the git clone completes, you\u2019ll have the latest version at the time of cloning. You should use git to fetch or pull the latest versions consequently."}),"\n",(0,i.jsx)(n.h3,{id:"dependencies",children:"Dependencies"}),"\n",(0,i.jsx)(n.p,{children:"Install the required dependencies necessary for compiling general software and for our use-case Lightning CLI."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt-get install \\\n build-essential \\\n clang \\\n pkg-config \\\n libssl-dev \\\n gcc-multilib \\\n protobuf-compiler\n"})}),"\n",(0,i.jsx)(n.h3,{id:"build",children:"Build"}),"\n",(0,i.jsxs)(n.p,{children:["Start by changing the directory to the project directory where the source code is stored. If you have followed the recommended location that'll be ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),", as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsx)(n.p,{children:"Run the Rust package manager clean and update commands."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo clean\ncargo update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, execute the build command to compile the Fleek Network Lightning CLI binary."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The build command uses the Rust compiler, which might take a while depending on how speedy the host machine is capable."})}),"\n",(0,i.jsxs)(n.p,{children:["Once the Rust compiler completes, the generated binary will be available in the source code project directory. If you stick with the default, that'll look like ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/debug/lightning-node"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["To avoid having to specify the pathname every time, create a symbolic link to keep it short. Here we'll name the process as the global ",(0,i.jsx)(n.code,{children:"lgtn"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "~/fleek-network/lightning/target/debug/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Run the CLI with the flag ",(0,i.jsx)(n.code,{children:"version"})," to confirm it's available globally."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn --version\n"})}),"\n",(0,i.jsx)(n.p,{children:"The output should look like:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Usage: lgtn [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n dev-init-only Initialize the node without starting it\n dev-dump-graph Dump the infusion graph of the node instance\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,i.jsx)(n.h3,{id:"node-launch",children:"Node Launch"}),"\n",(0,i.jsxs)(n.p,{children:["After ",(0,i.jsx)(n.a,{href:"#build",children:"building"}),", the node can be launched by running the subcommand ",(0,i.jsx)(n.code,{children:"run"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn run\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"It's highly recommend to use systemd to manage the Fleek Network service for node operators. Systemd is a system and service manager for Linux operating systems that provides a consistent way to manage system services across various distributions."})}),"\n",(0,i.jsxs)(n.p,{children:["Learn how to create a new Systemd service in the ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document."]}),"\n",(0,i.jsx)(n.h3,{id:"health-check",children:"Health check"}),"\n",(0,i.jsx)(n.p,{children:"It's important for Node operators to regularly check on the health of their resources to make sure everything is running smoothly. By doing this, they can get helpful feedback and know for sure if their Node is up and running. Some experienced node operators even automate this process using cronjobs and get reports sent to them via email or other custom methods."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,i.jsx)(n.p,{children:"If everything goes well, the response should be:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"OK\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, use the JSON-RPC method ",(0,i.jsx)(n.code,{children:"flk_ping"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -s \\\n -X POST \\\n -H "Content-Type: application/json" \\\n -d \'{\n "jsonrpc": "2.0",\n "method": "flk_ping",\n "params": [],\n "id": 1\n }\' \\\n localhost:4230/rpc/v0\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Which response should return the key ",(0,i.jsx)(n.code,{children:"result"})," with value ",(0,i.jsx)(n.code,{children:"pong"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'{\n "jsonrpc": "2.0",\n "result": "pong",\n "id": 1\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"next-steps",children:"Next steps"}),"\n",(0,i.jsx)(n.p,{children:"While you can run the Network Node as described here, it's required to set up the Network Node correctly and securely! It requires some degree of patience, knowledge and time to go through our guides, but we'll provide some guides and references to help you manage your network node server!"}),"\n",(0,i.jsxs)(n.p,{children:["To avoid having to go through all the steps manually, we recommend reading our ",(0,i.jsx)(n.a,{href:"/docs/node/install#assisted-installer",children:"assisted installer"})," document for quick onboarding."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"We introduced Fleek Network as an open-source edge computing platform to help us accelerate the development and execution of the next generation of web services."}),"\n",(0,i.jsx)(n.p,{children:"We have learned a bit about the importance of a decentralized edge computing network to reach and fulfill the future of computation and how the Fleek Network protocol works succinctly."}),"\n",(0,i.jsx)(n.p,{children:"Furthermore, we guide you through a step-by-step installation of the network node process, where we pull the source code, build the binary and launch the service."}),"\n",(0,i.jsx)(n.p,{children:"Finally, we do a quick health check to confirm the status of our node."}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,i.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},3183:(e,n,t)=>{t.d(n,{ZP:()=>r});var i=t(5893),o=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,i.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,i.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,i.jsxs)(n.li,{children:["Download the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,i.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,i.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(s,{...e})}):s(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var i=t(5893);const o=e=>{let{image:n,name:t,title:o,url:s,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:s,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:s,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:o}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},3483:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/getting-started-e00548e77105d1efbb6c436314fca278.png"},7860:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/getting-started-e00548e77105d1efbb6c436314fca278.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const o={},s=i.createContext(o);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2702],{5894:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>h});var i=t(5893),o=t(1151),s=t(3872),r=t(3183);const a={template:"post",draft:!1,hide_title:!0,title:"Getting Started",slug:"getting-started",date:new Date("2023-08-31T23:00:00.000Z"),image:"./assets/getting-started.png?202311181211",canonical:"",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",category:"Tutorial",tags:["Edge computing","Guide","Getting Started"]},l=void 0,d={id:"Node Operators/getting-started-guide",title:"Getting Started",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",source:"@site/guides/Node Operators/getting-started-guide.md",sourceDirName:"Node Operators",slug:"/Node Operators/getting-started",permalink:"/guides/Node Operators/getting-started",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/getting-started-guide.md",tags:[{label:"Edge computing",permalink:"/guides/tags/edge-computing"},{label:"Guide",permalink:"/guides/tags/guide"},{label:"Getting Started",permalink:"/guides/tags/getting-started"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{template:"post",draft:!1,hide_title:!0,title:"Getting Started",slug:"getting-started",date:"2023-08-31T23:00:00.000Z",image:"./assets/getting-started.png?202311181211",canonical:"",description:"A first look at what Fleek Network is, why it's important, and a simple tutorial of running and interacting with a node on your local machine!",category:"Tutorial",tags:["Edge computing","Guide","Getting Started"]},sidebar:"defaultSidebar",previous:{title:"About guides",permalink:"/guides/"},next:{title:"How to manage log files",permalink:"/guides/Node Operators/how-to-manage-log-files"}},c={image:t(3483).Z},h=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Need a quick Fleek Network TL;DR?",id:"need-a-quick-fleek-network-tldr",level:2},{value:"Why is Fleek Network needed?",id:"why-is-fleek-network-needed",level:2},{value:"How Does Fleek Network Work?",id:"how-does-fleek-network-work",level:2},{value:"Running a Node",id:"running-a-node",level:2},{value:"Clone the source code",id:"clone-the-source-code",level:3},{value:"Dependencies",id:"dependencies",level:3},{value:"Build",id:"build",level:3},{value:"Node Launch",id:"node-launch",level:3},{value:"Health check",id:"health-check",level:3},{value:"Next steps",id:"next-steps",level:2},{value:"Conclusion",id:"conclusion",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Getting started guide",src:t(7860).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"For this guide, we\u2019ll have a simple look into how Fleek Network works in its current development phase and briefly share some of the core concepts like spinning up a node."}),"\n",(0,i.jsx)(n.p,{children:"For those seeking advanced knowledge:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Read our ",(0,i.jsx)(n.a,{href:"/docs/whitepaper",children:"whitepaper"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["Check out ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"our open-source code"}),"."]}),"\n"]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["If you find any typos in our documentation, feel free to ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"provide us feedback"})," or contribute by opening a PR in our repository ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/fleek-network-docs/",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Git"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"need-a-quick-fleek-network-tldr",children:"Need a quick Fleek Network TL;DR?"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network is an open-source edge computing platform to accelerate the development and execution of the next generation of web services."}),"\n",(0,i.jsx)(n.p,{children:"The system is built on a distributed network of nodes, where services run within a fair and incentivized ecosystem constituted by an open community of developers and operators. It relies on blockchain technology at its core, allowing governance and token rewards as incentives for participation in serving the network."}),"\n",(0,i.jsx)(n.p,{children:"Made by an open community that's free to operate nodes or build services without the need for approvals, permissions, or intermediaries. Or simply, consume Fleek Network resources on demand, from anywhere, provided by services running on the edge."}),"\n",(0,i.jsx)(n.p,{children:"Applications, platforms and protocols build and utilize decentralized services on the Fleek Network to optimize performance and reduce dependency on typical centralized cloud providers and corporate infrastructure."}),"\n",(0,i.jsx)(n.p,{children:"Developers can build faster and launch better products by offloading parts of the development stack to the edge to focus on core features for the value proposition of the services being developed."}),"\n",(0,i.jsxs)(n.p,{children:["To get started, install a Network Node in a ",(0,i.jsx)(n.a,{href:"/docs/node/requirements",children:"supported"})," Linux server, such as Debian or Ubuntu (latest) by utilizing our simple ",(0,i.jsx)(n.a,{href:"/docs/node/install#assisted-installer",children:"assisted installer"})," to help onboard as quickly as possible."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"Our network is open to everyone, so you're more than welcome to join us anytime without any restrictions, permission or formalities. We'd be happy to have you as part of our community!"})}),"\n",(0,i.jsx)(n.p,{children:"Once connected to the server, open a terminal window and execute the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,i.jsx)(n.p,{children:"Follow the install assistant recommendations to have the node ready without hassle and as quickly as possible."}),"\n",(0,i.jsx)(n.h2,{id:"why-is-fleek-network-needed",children:"Why is Fleek Network needed?"}),"\n",(0,i.jsx)(n.p,{children:"Web3 products typically rely on centralized cloud infrastructure, which is vulnerable to attacks as computation and data can be easily manipulated to suit business goals. However, blockchain technology has paved the way for a new era of decentralized cloud computing and data storage. The Fleek Network offers a sustainable alternative to traditional centralized architectures, providing a secure, transparent, and accessible decentralized edge computing future for everyone."}),"\n",(0,i.jsx)(n.h2,{id:"how-does-fleek-network-work",children:"How Does Fleek Network Work?"}),"\n",(0,i.jsx)(n.p,{children:"When a client requests a service, the protocol determines the best route to the nodes where the service replicas and workload are allocated."}),"\n",(0,i.jsx)(n.p,{children:"Once the computation is successful, the data streaming routes to the client. On-client request fulfillment, a proof of delivery is generated containing cryptographically secured metadata about the original request, any parts involved and the resources consumed."}),"\n",(0,i.jsx)(n.p,{children:"The Delivery Acknowledgements are stored locally in the participating node memory pools, rolled up to the protocol consensus consistently throughout the Epoch. This agreement is formed by a random committee of any healthy Nodes that use the information provided to reward the Nodes fairly."}),"\n",(0,i.jsx)(n.h2,{id:"running-a-node",children:"Running a Node"}),"\n",(0,i.jsxs)(n.p,{children:["A Fleek Network node can be built and run on your machine. It\u2019s an ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"open-source project"})," and is open for contributions."]}),"\n",(0,i.jsx)(n.p,{children:"The project is written with Rust, a general-purpose programming language that you need to have installed in advance to be able to follow the current guide."}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To set up Rust, packages and library dependencies can be tricky. The quickest is to visit the ",(0,i.jsx)(n.a,{href:"https://rustup.rs/",children:"rustup.rs"}),". Alternatively, if you haven't already, the build section has a ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document to help."]})}),"\n",(0,i.jsx)(n.h3,{id:"clone-the-source-code",children:"Clone the source code"}),"\n",(0,i.jsx)(n.p,{children:"We\u2019ll clone the repository locally, build it and interact with the node through the binary or the HTTP JSON-RPC API with a client like cURL, but you can use a GUI (Postman, Insomnia, amongst others) if you prefer."}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsx)(n.p,{children:"The ~/fleek-network/lightning or $HOME/fleek-network/lightning directory is the default or recommended location to store the repository. If you like to follow conventions, then is best to stick with the recommendation, to avoid confusion and make it easier to follow our documentation."})}),"\n",(0,i.jsxs)(n.p,{children:["Start by cloning the repository located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"https://github.com/fleek-network/lightning"})]}),"\n",(0,i.jsx)(r.ZP,{}),"\n",(0,i.jsx)(n.p,{children:"Once the git clone completes, you\u2019ll have the latest version at the time of cloning. You should use git to fetch or pull the latest versions consequently."}),"\n",(0,i.jsx)(n.h3,{id:"dependencies",children:"Dependencies"}),"\n",(0,i.jsx)(n.p,{children:"Install the required dependencies necessary for compiling general software and for our use-case Lightning CLI."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt-get install \\\n build-essential \\\n clang \\\n pkg-config \\\n libssl-dev \\\n gcc-multilib \\\n protobuf-compiler\n"})}),"\n",(0,i.jsx)(n.h3,{id:"build",children:"Build"}),"\n",(0,i.jsxs)(n.p,{children:["Start by changing the directory to the project directory where the source code is stored. If you have followed the recommended location that'll be ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),", as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsx)(n.p,{children:"Run the Rust package manager clean and update commands."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo clean\ncargo update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, execute the build command to compile the Fleek Network Lightning CLI binary."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The build command uses the Rust compiler, which might take a while depending on how speedy the host machine is capable."})}),"\n",(0,i.jsxs)(n.p,{children:["Once the Rust compiler completes, the generated binary will be available in the source code project directory. If you stick with the default, that'll look like ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/debug/lightning-node"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["To avoid having to specify the pathname every time, create a symbolic link to keep it short. Here we'll name the process as the global ",(0,i.jsx)(n.code,{children:"lgtn"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "~/fleek-network/lightning/target/debug/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Run the CLI with the flag ",(0,i.jsx)(n.code,{children:"version"})," to confirm it's available globally."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn --version\n"})}),"\n",(0,i.jsx)(n.p,{children:"The output should look like:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Usage: lgtn [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n dev-init-only Initialize the node without starting it\n dev-dump-graph Dump the infusion graph of the node instance\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,i.jsx)(n.h3,{id:"node-launch",children:"Node Launch"}),"\n",(0,i.jsxs)(n.p,{children:["After ",(0,i.jsx)(n.a,{href:"#build",children:"building"}),", the node can be launched by running the subcommand ",(0,i.jsx)(n.code,{children:"run"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn run\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"It's highly recommend to use systemd to manage the Fleek Network service for node operators. Systemd is a system and service manager for Linux operating systems that provides a consistent way to manage system services across various distributions."})}),"\n",(0,i.jsxs)(n.p,{children:["Learn how to create a new Systemd service in the ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document."]}),"\n",(0,i.jsx)(n.h3,{id:"health-check",children:"Health check"}),"\n",(0,i.jsx)(n.p,{children:"It's important for Node operators to regularly check on the health of their resources to make sure everything is running smoothly. By doing this, they can get helpful feedback and know for sure if their Node is up and running. Some experienced node operators even automate this process using cronjobs and get reports sent to them via email or other custom methods."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,i.jsx)(n.p,{children:"If everything goes well, the response should be:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"OK\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, use the JSON-RPC method ",(0,i.jsx)(n.code,{children:"flk_ping"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -s \\\n -X POST \\\n -H "Content-Type: application/json" \\\n -d \'{\n "jsonrpc": "2.0",\n "method": "flk_ping",\n "params": [],\n "id": 1\n }\' \\\n localhost:4230/rpc/v0\n'})}),"\n",(0,i.jsxs)(n.p,{children:["Which response should return the key ",(0,i.jsx)(n.code,{children:"result"})," with value ",(0,i.jsx)(n.code,{children:"pong"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'{\n "jsonrpc": "2.0",\n "result": "pong",\n "id": 1\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"next-steps",children:"Next steps"}),"\n",(0,i.jsx)(n.p,{children:"While you can run the Network Node as described here, it's required to set up the Network Node correctly and securely! It requires some degree of patience, knowledge and time to go through our guides, but we'll provide some guides and references to help you manage your network node server!"}),"\n",(0,i.jsxs)(n.p,{children:["To avoid having to go through all the steps manually, we recommend reading our ",(0,i.jsx)(n.a,{href:"/docs/node/install#assisted-installer",children:"assisted installer"})," document for quick onboarding."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"We introduced Fleek Network as an open-source edge computing platform to help us accelerate the development and execution of the next generation of web services."}),"\n",(0,i.jsx)(n.p,{children:"We have learned a bit about the importance of a decentralized edge computing network to reach and fulfill the future of computation and how the Fleek Network protocol works succinctly."}),"\n",(0,i.jsx)(n.p,{children:"Furthermore, we guide you through a step-by-step installation of the network node process, where we pull the source code, build the binary and launch the service."}),"\n",(0,i.jsx)(n.p,{children:"Finally, we do a quick health check to confirm the status of our node."}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,i.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},3183:(e,n,t)=>{t.d(n,{ZP:()=>r});var i=t(5893),o=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,i.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,i.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,i.jsxs)(n.li,{children:["Download the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,i.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,i.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(s,{...e})}):s(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var i=t(5893);const o=e=>{let{image:n,name:t,title:o,url:s,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:s,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:s,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:o}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},3483:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/getting-started-e00548e77105d1efbb6c436314fca278.png"},7860:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/getting-started-e00548e77105d1efbb6c436314fca278.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const o={},s=i.createContext(o);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1d8a5d15.8054019c.js b/assets/js/1d8a5d15.e18454dc.js similarity index 99% rename from assets/js/1d8a5d15.8054019c.js rename to assets/js/1d8a5d15.e18454dc.js index 028bad2cd..e87e02e3d 100644 --- a/assets/js/1d8a5d15.8054019c.js +++ b/assets/js/1d8a5d15.e18454dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9854],{884:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>h,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>g});var s=t(5893),i=t(1151),r=t(3872),o=t(8432),l=t(1586);const a={template:"post",draft:!1,hide_title:!0,title:"Transfering setup ownership",slug:"transfering-setup-ownership",image:"./assets/transfering-setup-ownership.png?202311181223",date:new Date("2023-09-12T23:00:00.000Z"),description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",category:"Tutorial",tags:["transfer","ownership","guide","setup","configuration"]},h=void 0,d={id:"Node Operators/transfering-setup-ownership",title:"Transfering setup ownership",description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",source:"@site/guides/Node Operators/transfering-setup-ownership.md",sourceDirName:"Node Operators",slug:"/Node Operators/transfering-setup-ownership",permalink:"/guides/Node Operators/transfering-setup-ownership",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/transfering-setup-ownership.md",tags:[{label:"transfer",permalink:"/guides/tags/transfer"},{label:"ownership",permalink:"/guides/tags/ownership"},{label:"guide",permalink:"/guides/tags/guide"},{label:"setup",permalink:"/guides/tags/setup"},{label:"configuration",permalink:"/guides/tags/configuration"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{template:"post",draft:!1,hide_title:!0,title:"Transfering setup ownership",slug:"transfering-setup-ownership",image:"./assets/transfering-setup-ownership.png?202311181223",date:"2023-09-12T23:00:00.000Z",description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",category:"Tutorial",tags:["transfer","ownership","guide","setup","configuration"]},sidebar:"defaultSidebar",previous:{title:"Running a node in Docker",permalink:"/guides/Node Operators/running-a-node-in-docker"},next:{title:"Updating Lightning",permalink:"/guides/Node Operators/updating-lightning"}},c={image:t(9548).Z},g=[{value:"TL;DR",id:"tldr",level:2},{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Ownership of Lightning CLI files",id:"ownership-of-lightning-cli-files",level:2},{value:"Systemd Service",id:"systemd-service",level:2},{value:"Stop the service",id:"stop-the-service",level:2},{value:"Clear the .lightning data",id:"clear-the-lightning-data",level:2},{value:"Create a user",id:"create-a-user",level:2},{value:"Move lightning system and source code directory to user's home",id:"move-lightning-system-and-source-code-directory-to-users-home",level:2},{value:"1) Move the /root/.lightning directory from one user to the other",id:"1-move-the-rootlightning-directory-from-one-user-to-the-other",level:3},{value:"2) Move the /root/fleek-network directory from one user to the other",id:"2-move-the-rootfleek-network-directory-from-one-user-to-the-other",level:3},{value:"3) Confirm move by finding both directories",id:"3-confirm-move-by-finding-both-directories",level:3},{value:"Change ownership of files",id:"change-ownership-of-files",level:2},{value:"The lgtn symbolic link (symlink)",id:"the-lgtn-symbolic-link-symlink",level:2},{value:"Update the Systemd service unit",id:"update-the-systemd-service-unit",level:2},{value:"Update the config.toml with user-preferred file locations",id:"update-the-configtoml-with-user-preferred-file-locations",level:2},{value:"Start the service",id:"start-the-service",level:2},{value:"Conclusion",id:"conclusion",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Transfering setup ownership",src:t(2867).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,s.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsxs)(n.p,{children:["The step-by-step instructions provided in the guide should be simple to follow, but the process is also available as an automated script from our familiar ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/get.fleek.network",children:"get.fleek.network"})," tool."]}),(0,s.jsx)(n.p,{children:"To use the automated script execute the following command in your server terminal and follow the instructions:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/transfer_system_user_setup_ownership | bash\n"})}),(0,s.jsxs)(n.p,{children:["We try to make the auomated scripts as useful as possible, but it's impossible to fit every single use-case. So, if you find any isses or have feedback to help us improve ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"message us through our Discord"}),"."]})]}),"\n",(0,s.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsx)(n.p,{children:"Our Lightning CLI and Node process is run by a user, that has some sort of permissions\u2013some users run it as a super user (root) which is questionable as root privileges are not a necessary good. We'll look into how to create a user to manage and control the Fleek Network Lightning CLI and Systemd unit service. Also, presents the concept of file permissions and ownership which is crucial in preventing private or sensitive data from being exposed to dodgy actors."}),"\n",(0,s.jsx)(n.p,{children:"Let's discuss the topic and open up a few ideas to help us improve the security of our server."}),"\n",(0,s.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,s.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,s.jsx)(n.li,{children:"Have installed and set up the Lightning CLI and service"}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"ownership-of-lightning-cli-files",children:"Ownership of Lightning CLI files"}),"\n",(0,s.jsx)(n.p,{children:"The user who installs the Lightning CLI and sets the Service takes an important role that determines the location of the configuration files, the setup, and how the Systemd service is managed or controlled."}),"\n",(0,s.jsxs)(n.p,{children:["Our ",(0,s.jsx)(n.a,{href:"/docs/node/install",children:"install"})," document recommends creating a user and switching to the user to set up the service. You shouldn't want installed applications to run with elevated privileges. Applications are meant to be run with non-administrative privileges. If an application requires higher privileges, the administrator, such as a ",(0,s.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Sudo",children:"sudoer"})," should be able to elevate it. An application that has full access and control of a system can modify it in harmful ways, e.g. compromise the private keys."]}),"\n",(0,s.jsx)(n.p,{children:"For our guide, we'll illustrate the process of migration from a super user (root) to another user (sudo). The knowledge should be easily appliable for any other user-to-user migration. We stick with root user for simplicity and because that's the most common use case."}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["A reference document about ",(0,s.jsx)(n.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"File permissions and ownership"})," is available that explains how it works practically, by showcasing how the process can be started, how the node process locates the Keystore, etc."]})}),"\n",(0,s.jsx)(n.h2,{id:"systemd-service",children:"Systemd Service"}),"\n",(0,s.jsx)(n.p,{children:"In systemd, a unit refers to any resource that the system knows how to operate on and manage. This is the primary object that the systemd tools know how to deal with. These resources are defined using configuration files called unit files."}),"\n",(0,s.jsxs)(n.p,{children:["The recommended installation process features a ",(0,s.jsx)(n.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.service.html",children:"systemd.service"})," which is a resource that the system knows how to operate and manage by an administrator user."]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"When using a Systemd service to run a process, it operates comparably to running it directly. The key difference is that Systemd keeps track of all the processes and threads that are spawned. This means that when a service is stopped using systemctl, such as the Fleek Network Lightning Node service, all the child processes that were started by the service are also terminated. Additionally, by utilizing Systemd, a user can run the process in the background and configure it to start automatically on system startup."})}),"\n",(0,s.jsxs)(n.p,{children:["If you have followed the installation recommendations, find the systemd service unit in the location ",(0,s.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," (we are using Ubuntu Linux as an example to keep it short)."]}),"\n",(0,s.jsxs)(n.p,{children:["Make sure that you have set up a ",(0,s.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd unit service"}),", as recommended during the installation as this guide assumes you have one setup."]}),"\n",(0,s.jsx)(n.h2,{id:"stop-the-service",children:"Stop the service"}),"\n",(0,s.jsxs)(n.p,{children:["Before we proceed with any changes required for the migration, you'll have to stop the ",(0,s.jsx)(n.code,{children:"lightning.service"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"systemctl stop lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["For this guide, we are assuming that you are migrating ownership from ",(0,s.jsx)(n.strong,{children:"root"})," to a ",(0,s.jsx)(n.strong,{children:"sudoer"})," user. If not, you might be required to elevate privileges as ",(0,s.jsx)(n.strong,{children:"sudo"}),"** where required. For example, ",(0,s.jsx)(n.code,{children:"sudo systemctl stop lightning"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"clear-the-lightning-data",children:"Clear the .lightning data"}),"\n",(0,s.jsxs)(n.p,{children:["Run the following command to clear the ",(0,s.jsx)(n.code,{children:"/root/.lightning/data"}),", as it can be quite large, and we don't need to move it."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf /root/.lightning/data\n"})}),"\n",(0,s.jsx)(n.h2,{id:"create-a-user",children:"Create a user"}),"\n",(0,s.jsx)(o.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"move-lightning-system-and-source-code-directory-to-users-home",children:"Move lightning system and source code directory to user's home"}),"\n",(0,s.jsx)(n.p,{children:"A user should've been created, added the user to the sudo group, switched to the user, and changed the directory to the user's home."}),"\n",(0,s.jsxs)(n.p,{children:["Run the command ",(0,s.jsx)(n.code,{children:"pwd"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"pwd\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output would look like:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"/home/\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Given the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"/home/lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"You'll then move two directories:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["The ",(0,s.jsx)(n.code,{children:"/root/.lightning"})]}),"\n",(0,s.jsxs)(n.li,{children:["The source code under the parent ",(0,s.jsx)(n.code,{children:"/root/fleek-network"})]}),"\n"]}),"\n",(0,s.jsxs)(n.h3,{id:"1-move-the-rootlightning-directory-from-one-user-to-the-other",children:["1) Move the ",(0,s.jsx)(n.code,{children:"/root/.lightning"})," directory from one user to the other"]}),"\n",(0,s.jsxs)(n.p,{children:["For our demo, we have assumed ",(0,s.jsx)(n.strong,{children:"root"})," user to ",(0,s.jsx)(n.strong,{children:"sudoer"})," user named ",(0,s.jsx)(n.strong,{children:"lgtn"}),", thus that'll look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo mv /root/.lightning /home/lgtn/\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"2-move-the-rootfleek-network-directory-from-one-user-to-the-other",children:["2) Move the ",(0,s.jsx)(n.code,{children:"/root/fleek-network"})," directory from one user to the other"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo mv /root/fleek-network /home/lgtn/\n"})}),"\n",(0,s.jsx)(n.h3,{id:"3-confirm-move-by-finding-both-directories",children:"3) Confirm move by finding both directories"}),"\n",(0,s.jsxs)(n.p,{children:["In the user $HOME directory, you should be able to list the content of the directory and find the ",(0,s.jsx)(n.code,{children:".lightning"})," and ",(0,s.jsx)(n.code,{children:"fleek-network"})," directory."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should be similar to the following."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 13:51 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 root root 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 3 root root 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,s.jsx)(n.h2,{id:"change-ownership-of-files",children:"Change ownership of files"}),"\n",(0,s.jsxs)(n.p,{children:["Once the directories and files are moved, they should have the wrong ownership, which should be set to ",(0,s.jsxs)(n.strong,{children:["root",":root"]}),". We'll now have to change the ownership of the directories and files recursively."]}),"\n",(0,s.jsxs)(n.p,{children:["Change the ownership of ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning"})," to the user ",(0,s.jsx)(n.strong,{children:"lgtn"})," as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo chown -R lgtn:lgtn .lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Make sure that you use the ",(0,s.jsx)(n.code,{children:"-R"})," flag to have the ownership changes applied to the parent, the child directories and all the files."]})}),"\n",(0,s.jsxs)(n.p,{children:["Change the ownership of ",(0,s.jsx)(n.code,{children:"/home/lgtn/fleek-network"})," to the user ",(0,s.jsx)(n.strong,{children:"lgtn"})," as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo chown -R lgtn:lgtn fleek-network\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Once completed, if you list the content of the directory the ownership should have changed from ",(0,s.jsx)(n.code,{children:"root:root"})," to ",(0,s.jsx)(n.code,{children:"lgtn:lgtn"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should be similar to the following."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 13:51 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 3 lgtn lgtn 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsxs)(n.p,{children:["Remember that we are using ",(0,s.jsx)(n.strong,{children:"lgtn"})," for our demo. If you have opted for a different username, make sure you use the correct username. To find the username you are logged in with run the command:"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),(0,s.jsxs)(n.p,{children:["For our demo, we'll assume that you understand that ",(0,s.jsx)(n.strong,{children:"lgtn"})," is the user we opted in for our demo."]})]}),"\n",(0,s.jsx)(n.h2,{id:"the-lgtn-symbolic-link-symlink",children:"The lgtn symbolic link (symlink)"}),"\n",(0,s.jsxs)(n.p,{children:["We have the symbolic link that links the binary built from the source code, to the alias ",(0,s.jsx)(n.strong,{children:"lgtn"})," that's set under the ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"})," pathname."]}),"\n",(0,s.jsx)(n.p,{children:"For example, you can find where that is linked to by running:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la $(which lgtn)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["On the output below, we can see that the ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"})," points to ",(0,s.jsx)(n.code,{children:"/root/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lrwxrwxrwx 1 root root 64 Sep 11 15:48 /usr/local/bin/lgtn -> /root/fleek-network/lightning/target/release/lightning-node\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The target base path is ",(0,s.jsx)(n.code,{children:"/root"}),", and we know that we've moved the source code directory to the user home ",(0,s.jsx)(n.code,{children:"/home/lgtn"}),". For this reason, we need to create a new symlink with the updated location of the binary file."]}),"\n",(0,s.jsx)(n.p,{children:"Unlink the symlink:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo unlink /usr/local/bin/lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"Create the symlink:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "/home/lgtn/fleek-network/lightning/target/release/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,s.jsx)(n.p,{children:"If successful, you should be able to execute the command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lgtn help\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should look similar to:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"Usage: lgtn [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-systemd-service-unit",children:"Update the Systemd service unit"}),"\n",(0,s.jsx)(n.p,{children:"Open the file, its settings should be similar to the following:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml run\nExecStop=killall -9 lgtn\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Since we opted in for the username ",(0,s.jsx)(n.strong,{children:"lgtn"})," for our demo, replaced ",(0,s.jsx)(n.code,{children:""})," with ",(0,s.jsx)(n.code,{children:"lgtn"}),", and it would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml run\nExecStop=killall -9 lgtn\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Notice the ",(0,s.jsx)(n.code,{children:"ExecStart="})," which includes the flag ",(0,s.jsx)(n.code,{children:"-c"})," where the location of the user files is declared. Learn how to ",(0,s.jsx)(n.a,{href:"#update-the-configtoml-with-user-preferred-file-locations",children:"update the config.toml"})," to include the user-preferred file paths, e.g. declare the keystore pathname."]})}),"\n",(0,s.jsx)(n.p,{children:"Complete the step by reloading the daemon, to apply the newly created changes. You can do this by executing:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-configtoml-with-user-preferred-file-locations",children:"Update the config.toml with user-preferred file locations"}),"\n",(0,s.jsxs)(n.p,{children:["Open the ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," file in your favorite text editor."]}),"\n",(0,s.jsxs)(n.p,{children:["Replace every instance of ",(0,s.jsx)(n.code,{children:"~"})," (tilde) with the user's home path. We do this to ensure that every time we control the service via systemctl, the configuration file that tells which keystore to use is declared upfront regardless of running it as user or delegating to root with ",(0,s.jsx)(n.strong,{children:"sudo"}),". Learn more about ",(0,s.jsx)(n.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"file permissions and ownership"})," by reading the reference document."]}),"\n",(0,s.jsx)(l.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"start-the-service",children:"Start the service"}),"\n",(0,s.jsx)(n.p,{children:"At this stage, you should have migrated the essential files to the user home."}),"\n",(0,s.jsxs)(n.p,{children:["Ideally, you would now manage the service as the ",(0,s.jsx)(n.code,{children:"user"})," (as described in the ",(0,s.jsx)(n.a,{href:"/references/Systemd/user-service/",children:"user service reference"}),"). To keep our guide wider to all users, we'll prefix the commands with ",(0,s.jsx)(n.strong,{children:"sudo"}),", which elevates the permissions to ",(0,s.jsx)(n.strong,{children:"root"}),". But since we have provided the configuration file the ",(0,s.jsx)(n.code,{children:"-c"})," in our ",(0,s.jsx)(n.a,{href:"#systemd-service",children:"systemd service"}),", we'll have the user-preferred configuration options ruling."]}),"\n",(0,s.jsx)(n.p,{children:"Start the service by running the command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning.service\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Find the timeline of events for the Lightning service by checking the log files. Learn about it in the section ",(0,s.jsx)(n.a,{href:"/docs/node/install#analyzing-log-messages",children:"Log Messages"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["To learn more, visit the section ",(0,s.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"Use Systemctl to manage the Lightning Service"})]}),"\n",(0,s.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,s.jsx)(n.p,{children:"We started by giving a brief introduction to ownership of the Lightning CLI files."}),"\n",(0,s.jsx)(n.p,{children:"Jumped through topics of Systemd service that helps the user manage the service in the Linux environment, which helps keep track of all the processes and threads that are spawned."}),"\n",(0,s.jsxs)(n.p,{children:["We've gone through the step-by-step process to migrate the Fleek Network CLI and Systemd service setup from one user to the other. To keep it short, we decided to go with the use-case of where the migration happens between a ",(0,s.jsx)(n.strong,{children:"root"})," user and a ",(0,s.jsx)(n.strong,{children:"sudoer"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Discover more about the project by ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,s.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,s.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8432:(e,n,t)=>{t.d(n,{ZP:()=>o});var s=t(5893),i=t(1151);function r(e){const n={admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["We recommend creating a ",(0,s.jsx)(n.code,{children:"non-root"})," user with administrative privileges. It'll allow us to install any system requirements."]}),"\n",(0,s.jsxs)(n.p,{children:["You can create a new user and add to the ",(0,s.jsx)(n.strong,{children:"sudo"})," group by running:"]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["For our example, we'll be using the name ",(0,s.jsx)(n.code,{children:"lgtn"})," but you can pick whichever you'd like. If you already have a ",(0,s.jsx)(n.strong,{children:"sudoer"})," account, you can skip this step."]})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo adduser lgtn\n"})}),"\n",(0,s.jsxs)(n.p,{children:["After completing the ",(0,s.jsx)(n.code,{children:"adduser"})," steps, execute the ",(0,s.jsx)(n.code,{children:"usermod"})," to add the ",(0,s.jsx)(n.code,{children:"user"})," to the ",(0,s.jsx)(n.strong,{children:"sudo"})," group, as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo usermod -aG sudo lgtn\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Switch to the new ",(0,s.jsx)(n.strong,{children:"user"})," by using the command:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"Change the directory to the new user's home, as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cd /home/lgtn\n"})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},1586:(e,n,t)=>{t.d(n,{ZP:()=>o});var s=t(5893),i=t(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,s.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,s.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Replace the ",(0,s.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if your username is ",(0,s.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Once modified, you can run a ",(0,s.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,s.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,s.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>i});t(7294);var s=t(5893);const i=e=>{let{image:n,name:t,title:i,url:r,communityMember:o=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:t,children:(0,s.jsx)("img",{src:n,alt:t})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:t,children:t})}),(0,s.jsx)("span",{className:"title",children:i}),(0,s.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},9548:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/transfering-setup-ownership-e59591d6c2b6023384e94dfa4873964a.png"},2867:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/transfering-setup-ownership-e59591d6c2b6023384e94dfa4873964a.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>o});var s=t(7294);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9854],{884:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>h,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>g});var s=t(5893),i=t(1151),r=t(3872),o=t(8432),l=t(1586);const a={template:"post",draft:!1,hide_title:!0,title:"Transfering setup ownership",slug:"transfering-setup-ownership",image:"./assets/transfering-setup-ownership.png?202311181223",date:new Date("2023-09-12T23:00:00.000Z"),description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",category:"Tutorial",tags:["transfer","ownership","guide","setup","configuration"]},h=void 0,d={id:"Node Operators/transfering-setup-ownership",title:"Transfering setup ownership",description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",source:"@site/guides/Node Operators/transfering-setup-ownership.md",sourceDirName:"Node Operators",slug:"/Node Operators/transfering-setup-ownership",permalink:"/guides/Node Operators/transfering-setup-ownership",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/transfering-setup-ownership.md",tags:[{label:"transfer",permalink:"/guides/tags/transfer"},{label:"ownership",permalink:"/guides/tags/ownership"},{label:"guide",permalink:"/guides/tags/guide"},{label:"setup",permalink:"/guides/tags/setup"},{label:"configuration",permalink:"/guides/tags/configuration"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{template:"post",draft:!1,hide_title:!0,title:"Transfering setup ownership",slug:"transfering-setup-ownership",image:"./assets/transfering-setup-ownership.png?202311181223",date:"2023-09-12T23:00:00.000Z",description:"A step-by-step guide to transfer the ownership of the Fleek Network Lightning CLI and service setup",category:"Tutorial",tags:["transfer","ownership","guide","setup","configuration"]},sidebar:"defaultSidebar",previous:{title:"Running a node in Docker",permalink:"/guides/Node Operators/running-a-node-in-docker"},next:{title:"Updating Lightning",permalink:"/guides/Node Operators/updating-lightning"}},c={image:t(9548).Z},g=[{value:"TL;DR",id:"tldr",level:2},{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Ownership of Lightning CLI files",id:"ownership-of-lightning-cli-files",level:2},{value:"Systemd Service",id:"systemd-service",level:2},{value:"Stop the service",id:"stop-the-service",level:2},{value:"Clear the .lightning data",id:"clear-the-lightning-data",level:2},{value:"Create a user",id:"create-a-user",level:2},{value:"Move lightning system and source code directory to user's home",id:"move-lightning-system-and-source-code-directory-to-users-home",level:2},{value:"1) Move the /root/.lightning directory from one user to the other",id:"1-move-the-rootlightning-directory-from-one-user-to-the-other",level:3},{value:"2) Move the /root/fleek-network directory from one user to the other",id:"2-move-the-rootfleek-network-directory-from-one-user-to-the-other",level:3},{value:"3) Confirm move by finding both directories",id:"3-confirm-move-by-finding-both-directories",level:3},{value:"Change ownership of files",id:"change-ownership-of-files",level:2},{value:"The lgtn symbolic link (symlink)",id:"the-lgtn-symbolic-link-symlink",level:2},{value:"Update the Systemd service unit",id:"update-the-systemd-service-unit",level:2},{value:"Update the config.toml with user-preferred file locations",id:"update-the-configtoml-with-user-preferred-file-locations",level:2},{value:"Start the service",id:"start-the-service",level:2},{value:"Conclusion",id:"conclusion",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"Transfering setup ownership",src:t(2867).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,s.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsxs)(n.p,{children:["The step-by-step instructions provided in the guide should be simple to follow, but the process is also available as an automated script from our familiar ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/get.fleek.network",children:"get.fleek.network"})," tool."]}),(0,s.jsx)(n.p,{children:"To use the automated script execute the following command in your server terminal and follow the instructions:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/transfer_system_user_setup_ownership | bash\n"})}),(0,s.jsxs)(n.p,{children:["We try to make the auomated scripts as useful as possible, but it's impossible to fit every single use-case. So, if you find any isses or have feedback to help us improve ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"message us through our Discord"}),"."]})]}),"\n",(0,s.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsx)(n.p,{children:"Our Lightning CLI and Node process is run by a user, that has some sort of permissions\u2013some users run it as a super user (root) which is questionable as root privileges are not a necessary good. We'll look into how to create a user to manage and control the Fleek Network Lightning CLI and Systemd unit service. Also, presents the concept of file permissions and ownership which is crucial in preventing private or sensitive data from being exposed to dodgy actors."}),"\n",(0,s.jsx)(n.p,{children:"Let's discuss the topic and open up a few ideas to help us improve the security of our server."}),"\n",(0,s.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,s.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,s.jsx)(n.li,{children:"Have installed and set up the Lightning CLI and service"}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"ownership-of-lightning-cli-files",children:"Ownership of Lightning CLI files"}),"\n",(0,s.jsx)(n.p,{children:"The user who installs the Lightning CLI and sets the Service takes an important role that determines the location of the configuration files, the setup, and how the Systemd service is managed or controlled."}),"\n",(0,s.jsxs)(n.p,{children:["Our ",(0,s.jsx)(n.a,{href:"/docs/node/install",children:"install"})," document recommends creating a user and switching to the user to set up the service. You shouldn't want installed applications to run with elevated privileges. Applications are meant to be run with non-administrative privileges. If an application requires higher privileges, the administrator, such as a ",(0,s.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Sudo",children:"sudoer"})," should be able to elevate it. An application that has full access and control of a system can modify it in harmful ways, e.g. compromise the private keys."]}),"\n",(0,s.jsx)(n.p,{children:"For our guide, we'll illustrate the process of migration from a super user (root) to another user (sudo). The knowledge should be easily appliable for any other user-to-user migration. We stick with root user for simplicity and because that's the most common use case."}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["A reference document about ",(0,s.jsx)(n.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"File permissions and ownership"})," is available that explains how it works practically, by showcasing how the process can be started, how the node process locates the Keystore, etc."]})}),"\n",(0,s.jsx)(n.h2,{id:"systemd-service",children:"Systemd Service"}),"\n",(0,s.jsx)(n.p,{children:"In systemd, a unit refers to any resource that the system knows how to operate on and manage. This is the primary object that the systemd tools know how to deal with. These resources are defined using configuration files called unit files."}),"\n",(0,s.jsxs)(n.p,{children:["The recommended installation process features a ",(0,s.jsx)(n.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.service.html",children:"systemd.service"})," which is a resource that the system knows how to operate and manage by an administrator user."]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsx)(n.p,{children:"When using a Systemd service to run a process, it operates comparably to running it directly. The key difference is that Systemd keeps track of all the processes and threads that are spawned. This means that when a service is stopped using systemctl, such as the Fleek Network Lightning Node service, all the child processes that were started by the service are also terminated. Additionally, by utilizing Systemd, a user can run the process in the background and configure it to start automatically on system startup."})}),"\n",(0,s.jsxs)(n.p,{children:["If you have followed the installation recommendations, find the systemd service unit in the location ",(0,s.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," (we are using Ubuntu Linux as an example to keep it short)."]}),"\n",(0,s.jsxs)(n.p,{children:["Make sure that you have set up a ",(0,s.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd unit service"}),", as recommended during the installation as this guide assumes you have one setup."]}),"\n",(0,s.jsx)(n.h2,{id:"stop-the-service",children:"Stop the service"}),"\n",(0,s.jsxs)(n.p,{children:["Before we proceed with any changes required for the migration, you'll have to stop the ",(0,s.jsx)(n.code,{children:"lightning.service"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"systemctl stop lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["For this guide, we are assuming that you are migrating ownership from ",(0,s.jsx)(n.strong,{children:"root"})," to a ",(0,s.jsx)(n.strong,{children:"sudoer"})," user. If not, you might be required to elevate privileges as ",(0,s.jsx)(n.strong,{children:"sudo"}),"** where required. For example, ",(0,s.jsx)(n.code,{children:"sudo systemctl stop lightning"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"clear-the-lightning-data",children:"Clear the .lightning data"}),"\n",(0,s.jsxs)(n.p,{children:["Run the following command to clear the ",(0,s.jsx)(n.code,{children:"/root/.lightning/data"}),", as it can be quite large, and we don't need to move it."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf /root/.lightning/data\n"})}),"\n",(0,s.jsx)(n.h2,{id:"create-a-user",children:"Create a user"}),"\n",(0,s.jsx)(o.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"move-lightning-system-and-source-code-directory-to-users-home",children:"Move lightning system and source code directory to user's home"}),"\n",(0,s.jsx)(n.p,{children:"A user should've been created, added the user to the sudo group, switched to the user, and changed the directory to the user's home."}),"\n",(0,s.jsxs)(n.p,{children:["Run the command ",(0,s.jsx)(n.code,{children:"pwd"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"pwd\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output would look like:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"/home/\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Given the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"/home/lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"You'll then move two directories:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["The ",(0,s.jsx)(n.code,{children:"/root/.lightning"})]}),"\n",(0,s.jsxs)(n.li,{children:["The source code under the parent ",(0,s.jsx)(n.code,{children:"/root/fleek-network"})]}),"\n"]}),"\n",(0,s.jsxs)(n.h3,{id:"1-move-the-rootlightning-directory-from-one-user-to-the-other",children:["1) Move the ",(0,s.jsx)(n.code,{children:"/root/.lightning"})," directory from one user to the other"]}),"\n",(0,s.jsxs)(n.p,{children:["For our demo, we have assumed ",(0,s.jsx)(n.strong,{children:"root"})," user to ",(0,s.jsx)(n.strong,{children:"sudoer"})," user named ",(0,s.jsx)(n.strong,{children:"lgtn"}),", thus that'll look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo mv /root/.lightning /home/lgtn/\n"})}),"\n",(0,s.jsxs)(n.h3,{id:"2-move-the-rootfleek-network-directory-from-one-user-to-the-other",children:["2) Move the ",(0,s.jsx)(n.code,{children:"/root/fleek-network"})," directory from one user to the other"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo mv /root/fleek-network /home/lgtn/\n"})}),"\n",(0,s.jsx)(n.h3,{id:"3-confirm-move-by-finding-both-directories",children:"3) Confirm move by finding both directories"}),"\n",(0,s.jsxs)(n.p,{children:["In the user $HOME directory, you should be able to list the content of the directory and find the ",(0,s.jsx)(n.code,{children:".lightning"})," and ",(0,s.jsx)(n.code,{children:"fleek-network"})," directory."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should be similar to the following."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 13:51 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 root root 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 3 root root 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,s.jsx)(n.h2,{id:"change-ownership-of-files",children:"Change ownership of files"}),"\n",(0,s.jsxs)(n.p,{children:["Once the directories and files are moved, they should have the wrong ownership, which should be set to ",(0,s.jsxs)(n.strong,{children:["root",":root"]}),". We'll now have to change the ownership of the directories and files recursively."]}),"\n",(0,s.jsxs)(n.p,{children:["Change the ownership of ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning"})," to the user ",(0,s.jsx)(n.strong,{children:"lgtn"})," as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo chown -R lgtn:lgtn .lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Make sure that you use the ",(0,s.jsx)(n.code,{children:"-R"})," flag to have the ownership changes applied to the parent, the child directories and all the files."]})}),"\n",(0,s.jsxs)(n.p,{children:["Change the ownership of ",(0,s.jsx)(n.code,{children:"/home/lgtn/fleek-network"})," to the user ",(0,s.jsx)(n.strong,{children:"lgtn"})," as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo chown -R lgtn:lgtn fleek-network\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Once completed, if you list the content of the directory the ownership should have changed from ",(0,s.jsx)(n.code,{children:"root:root"})," to ",(0,s.jsx)(n.code,{children:"lgtn:lgtn"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should be similar to the following."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 13:51 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 3 lgtn lgtn 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsxs)(n.p,{children:["Remember that we are using ",(0,s.jsx)(n.strong,{children:"lgtn"})," for our demo. If you have opted for a different username, make sure you use the correct username. To find the username you are logged in with run the command:"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),(0,s.jsxs)(n.p,{children:["For our demo, we'll assume that you understand that ",(0,s.jsx)(n.strong,{children:"lgtn"})," is the user we opted in for our demo."]})]}),"\n",(0,s.jsx)(n.h2,{id:"the-lgtn-symbolic-link-symlink",children:"The lgtn symbolic link (symlink)"}),"\n",(0,s.jsxs)(n.p,{children:["We have the symbolic link that links the binary built from the source code, to the alias ",(0,s.jsx)(n.strong,{children:"lgtn"})," that's set under the ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"})," pathname."]}),"\n",(0,s.jsx)(n.p,{children:"For example, you can find where that is linked to by running:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"ls -la $(which lgtn)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["On the output below, we can see that the ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"})," points to ",(0,s.jsx)(n.code,{children:"/root/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lrwxrwxrwx 1 root root 64 Sep 11 15:48 /usr/local/bin/lgtn -> /root/fleek-network/lightning/target/release/lightning-node\n"})}),"\n",(0,s.jsxs)(n.p,{children:["The target base path is ",(0,s.jsx)(n.code,{children:"/root"}),", and we know that we've moved the source code directory to the user home ",(0,s.jsx)(n.code,{children:"/home/lgtn"}),". For this reason, we need to create a new symlink with the updated location of the binary file."]}),"\n",(0,s.jsx)(n.p,{children:"Unlink the symlink:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo unlink /usr/local/bin/lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"Create the symlink:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "/home/lgtn/fleek-network/lightning/target/release/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,s.jsx)(n.p,{children:"If successful, you should be able to execute the command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lgtn help\n"})}),"\n",(0,s.jsx)(n.p,{children:"The output should look similar to:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"Usage: lgtn [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-systemd-service-unit",children:"Update the Systemd service unit"}),"\n",(0,s.jsx)(n.p,{children:"Open the file, its settings should be similar to the following:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml run\nExecStop=killall -9 lgtn\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Since we opted in for the username ",(0,s.jsx)(n.strong,{children:"lgtn"})," for our demo, replaced ",(0,s.jsx)(n.code,{children:""})," with ",(0,s.jsx)(n.code,{children:"lgtn"}),", and it would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml run\nExecStop=killall -9 lgtn\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Notice the ",(0,s.jsx)(n.code,{children:"ExecStart="})," which includes the flag ",(0,s.jsx)(n.code,{children:"-c"})," where the location of the user files is declared. Learn how to ",(0,s.jsx)(n.a,{href:"#update-the-configtoml-with-user-preferred-file-locations",children:"update the config.toml"})," to include the user-preferred file paths, e.g. declare the keystore pathname."]})}),"\n",(0,s.jsx)(n.p,{children:"Complete the step by reloading the daemon, to apply the newly created changes. You can do this by executing:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-configtoml-with-user-preferred-file-locations",children:"Update the config.toml with user-preferred file locations"}),"\n",(0,s.jsxs)(n.p,{children:["Open the ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," file in your favorite text editor."]}),"\n",(0,s.jsxs)(n.p,{children:["Replace every instance of ",(0,s.jsx)(n.code,{children:"~"})," (tilde) with the user's home path. We do this to ensure that every time we control the service via systemctl, the configuration file that tells which keystore to use is declared upfront regardless of running it as user or delegating to root with ",(0,s.jsx)(n.strong,{children:"sudo"}),". Learn more about ",(0,s.jsx)(n.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"file permissions and ownership"})," by reading the reference document."]}),"\n",(0,s.jsx)(l.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"start-the-service",children:"Start the service"}),"\n",(0,s.jsx)(n.p,{children:"At this stage, you should have migrated the essential files to the user home."}),"\n",(0,s.jsxs)(n.p,{children:["Ideally, you would now manage the service as the ",(0,s.jsx)(n.code,{children:"user"})," (as described in the ",(0,s.jsx)(n.a,{href:"/references/Systemd/user-service/",children:"user service reference"}),"). To keep our guide wider to all users, we'll prefix the commands with ",(0,s.jsx)(n.strong,{children:"sudo"}),", which elevates the permissions to ",(0,s.jsx)(n.strong,{children:"root"}),". But since we have provided the configuration file the ",(0,s.jsx)(n.code,{children:"-c"})," in our ",(0,s.jsx)(n.a,{href:"#systemd-service",children:"systemd service"}),", we'll have the user-preferred configuration options ruling."]}),"\n",(0,s.jsx)(n.p,{children:"Start the service by running the command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning.service\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Find the timeline of events for the Lightning service by checking the log files. Learn about it in the section ",(0,s.jsx)(n.a,{href:"/docs/node/install#analyzing-log-messages",children:"Log Messages"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["To learn more, visit the section ",(0,s.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"Use Systemctl to manage the Lightning Service"})]}),"\n",(0,s.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,s.jsx)(n.p,{children:"We started by giving a brief introduction to ownership of the Lightning CLI files."}),"\n",(0,s.jsx)(n.p,{children:"Jumped through topics of Systemd service that helps the user manage the service in the Linux environment, which helps keep track of all the processes and threads that are spawned."}),"\n",(0,s.jsxs)(n.p,{children:["We've gone through the step-by-step process to migrate the Fleek Network CLI and Systemd service setup from one user to the other. To keep it short, we decided to go with the use-case of where the migration happens between a ",(0,s.jsx)(n.strong,{children:"root"})," user and a ",(0,s.jsx)(n.strong,{children:"sudoer"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Discover more about the project by ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,s.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,s.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8432:(e,n,t)=>{t.d(n,{ZP:()=>o});var s=t(5893),i=t(1151);function r(e){const n={admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["We recommend creating a ",(0,s.jsx)(n.code,{children:"non-root"})," user with administrative privileges. It'll allow us to install any system requirements."]}),"\n",(0,s.jsxs)(n.p,{children:["You can create a new user and add to the ",(0,s.jsx)(n.strong,{children:"sudo"})," group by running:"]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["For our example, we'll be using the name ",(0,s.jsx)(n.code,{children:"lgtn"})," but you can pick whichever you'd like. If you already have a ",(0,s.jsx)(n.strong,{children:"sudoer"})," account, you can skip this step."]})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo adduser lgtn\n"})}),"\n",(0,s.jsxs)(n.p,{children:["After completing the ",(0,s.jsx)(n.code,{children:"adduser"})," steps, execute the ",(0,s.jsx)(n.code,{children:"usermod"})," to add the ",(0,s.jsx)(n.code,{children:"user"})," to the ",(0,s.jsx)(n.strong,{children:"sudo"})," group, as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo usermod -aG sudo lgtn\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Switch to the new ",(0,s.jsx)(n.strong,{children:"user"})," by using the command:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,s.jsx)(n.p,{children:"Change the directory to the new user's home, as follows:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cd /home/lgtn\n"})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},1586:(e,n,t)=>{t.d(n,{ZP:()=>o});var s=t(5893),i=t(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,s.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,s.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Replace the ",(0,s.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if your username is ",(0,s.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Once modified, you can run a ",(0,s.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,s.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,s.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>i});t(7294);var s=t(5893);const i=e=>{let{image:n,name:t,title:i,url:r,communityMember:o=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:t,children:(0,s.jsx)("img",{src:n,alt:t})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:t,children:t})}),(0,s.jsx)("span",{className:"title",children:i}),(0,s.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},9548:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/transfering-setup-ownership-e59591d6c2b6023384e94dfa4873964a.png"},2867:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/transfering-setup-ownership-e59591d6c2b6023384e94dfa4873964a.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>o});var s=t(7294);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/26b85cb6.70653ead.js b/assets/js/26b85cb6.7aca1da0.js similarity index 99% rename from assets/js/26b85cb6.70653ead.js rename to assets/js/26b85cb6.7aca1da0.js index f95c7c0cf..c3645fa5e 100644 --- a/assets/js/26b85cb6.70653ead.js +++ b/assets/js/26b85cb6.7aca1da0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7055],{1586:(e,n,t)=>{t.d(n,{ZP:()=>i});var o=t(5893),r=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["In the ",(0,o.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,o.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,o.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,o.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,o.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Replace the ",(0,o.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,o.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,o.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,o.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["For example, if your username is ",(0,o.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Once modified, you can run a ",(0,o.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,o.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,o.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,o.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function i(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}},5979:(e,n,t)=>{t.d(n,{ZP:()=>i});var o=t(5893),r=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["You can restore the keystore (Public Keys) by copying the directory to the ",(0,o.jsx)(n.code,{children:"~/.lightning"})," directory."]}),"\n",(0,o.jsx)(n.p,{children:"Let's assume that you know where your backup directory or files are located. To keep our instructions easy to follow, let's say that:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The keystore and files are located under the hypothetical location ",(0,o.jsx)(n.code,{children:"/my-keystore-backup"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The files in the ",(0,o.jsx)(n.code,{children:"/my-keystore-backup"})," are the following:"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"/my-keystore-backup\n\u251c\u2500\u2500 consensus.pem\n\u2514\u2500\u2500 node.pem\n\n1 directory, 2 files\n"})}),"\n",(0,o.jsx)(n.p,{children:"Considering the above for our example, you would have to run the following command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv /my-keystore-backup /home//.lightning/keystore\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Remember to replace the ",(0,o.jsx)(n.code,{children:""})," with the correct username for the setup. For example, if you have installed the Fleek Network with the username ",(0,o.jsx)(n.code,{children:"lgtn"})," that would be ",(0,o.jsx)(n.code,{children:"/home/lgtn/.lightning/keystore"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["Once moved, remember to start the service, you can learn how to manage the service by reading the section ",(0,o.jsx)(n.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})]})}function i(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}},6172:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>h,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>g});var o=t(5893),r=t(1151),s=t(3872),i=t(1586),l=t(5979);const a={title:"Restore the keystore",slug:"restore-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},h=void 0,c={id:"Lightning CLI/restore-keystore",title:"Restore the keystore",description:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only.",source:"@site/references/Lightning CLI/restore-keystore.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/restore-the-keystore",permalink:"/references/Lightning CLI/restore-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/restore-keystore.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"keystore",permalink:"/references/tags/keystore"},{label:"backup",permalink:"/references/tags/backup"},{label:"restore",permalink:"/references/tags/restore"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Restore the keystore",slug:"restore-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},sidebar:"defaultSidebar",previous:{title:"Permission denied (os error 13)",permalink:"/references/Lightning CLI/permission-denied-os-error-13"},next:{title:"Uninstall Lightning Node",permalink:"/references/Lightning CLI/uninstall-lightning-node"}},d={},g=[{value:"Switch user",id:"switch-user",level:2},{value:"Change directory to user home",id:"change-directory-to-user-home",level:2},{value:"Clear the config.toml",id:"clear-the-configtoml",level:2},{value:"Create a new config.toml",id:"create-a-new-configtoml",level:2},{value:"Update the config.toml with user home path",id:"update-the-configtoml-with-user-home-path",level:2},{value:"Restoring the keystore",id:"restoring-the-keystore",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.admonition,{type:"caution",children:(0,o.jsx)(n.p,{children:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."})}),"\n",(0,o.jsx)(n.h2,{id:"switch-user",children:"Switch user"}),"\n",(0,o.jsxs)(n.p,{children:["Switch to the correct username you have used to install and set up the Fleek Network Lightning. For example, let's say that the username is ",(0,o.jsx)(n.code,{children:"lgtn"}),". The command you'd have to run would be:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"su lgtn\n"})}),"\n",(0,o.jsx)(n.h2,{id:"change-directory-to-user-home",children:"Change directory to user home"}),"\n",(0,o.jsxs)(n.p,{children:["Change directory to the user you have used to install and set up the Fleek Network Lightning. For example, if you have used the username ",(0,o.jsx)(n.code,{children:"lgtn"})," the command would be:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"cd $HOME\n"})}),"\n",(0,o.jsx)(n.p,{children:"In other words:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"cd /home/lgtn\n"})}),"\n",(0,o.jsx)(n.h2,{id:"clear-the-configtoml",children:"Clear the config.toml"}),"\n",(0,o.jsxs)(n.p,{children:["You should can delete, backup or move the ",(0,o.jsx)(n.code,{children:"config.toml"})," file in order to reset it."]}),"\n",(0,o.jsx)(n.p,{children:"It might be necessary to, if your configuration, e.g. is corrupted, or you want to reset it for any other reason."}),"\n",(0,o.jsx)(n.p,{children:"To move or backup, run:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv ~/.lightning/config.toml ~/.lightning/config.toml.backup\n"})}),"\n",(0,o.jsx)(n.p,{children:"If you don't have a use-case for the backup, delete the file. To delete, run the command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"rm ~/.lightning/config.toml\n"})}),"\n",(0,o.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,o.jsxs)(n.p,{children:["You should have switched to the correct username. If you haven't done it, when stating ",(0,o.jsx)(n.code,{children:"~"})," that will refer to the current username home, which can be anything other than the correct username! Make sure you have switched to the correct username used during the installation and set up of Fleek Network Lightning to avoid confusion and issues."]})}),"\n",(0,o.jsx)(n.h2,{id:"create-a-new-configtoml",children:"Create a new config.toml"}),"\n",(0,o.jsx)(n.p,{children:"A new configuration file can be created by running the following command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"lgtn print-config --default > ~/.lightning/config.toml\n"})}),"\n",(0,o.jsx)(n.h2,{id:"update-the-configtoml-with-user-home-path",children:"Update the config.toml with user home path"}),"\n",(0,o.jsx)(i.ZP,{}),"\n",(0,o.jsx)(n.h2,{id:"restoring-the-keystore",children:"Restoring the keystore"}),"\n",(0,o.jsx)(l.ZP,{}),"\n",(0,o.jsxs)(n.p,{children:["For a more in depth or step-by-step instructions read the guide ",(0,o.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,o.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>r});t(7294);var o=t(5893);const r=e=>{let{image:n,name:t,title:r,url:s,communityMember:i=!1}=e;return(0,o.jsx)("section",{className:"author_card",children:(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"avatar",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:t,children:(0,o.jsx)("img",{src:n,alt:t})})}),(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"name",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:t,children:t})}),(0,o.jsx)("span",{className:"title",children:r}),(0,o.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,o.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>i});var o=t(7294);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7055],{1586:(e,n,t)=>{t.d(n,{ZP:()=>i});var o=t(5893),r=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["In the ",(0,o.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,o.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,o.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,o.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,o.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Replace the ",(0,o.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,o.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,o.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,o.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["For example, if your username is ",(0,o.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,o.jsxs)(n.p,{children:["Once modified, you can run a ",(0,o.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,o.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,o.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,o.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,o.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function i(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}},5979:(e,n,t)=>{t.d(n,{ZP:()=>i});var o=t(5893),r=t(1151);function s(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["You can restore the keystore (Public Keys) by copying the directory to the ",(0,o.jsx)(n.code,{children:"~/.lightning"})," directory."]}),"\n",(0,o.jsx)(n.p,{children:"Let's assume that you know where your backup directory or files are located. To keep our instructions easy to follow, let's say that:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The keystore and files are located under the hypothetical location ",(0,o.jsx)(n.code,{children:"/my-keystore-backup"})]}),"\n"]}),"\n",(0,o.jsxs)(n.li,{children:["\n",(0,o.jsxs)(n.p,{children:["The files in the ",(0,o.jsx)(n.code,{children:"/my-keystore-backup"})," are the following:"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"/my-keystore-backup\n\u251c\u2500\u2500 consensus.pem\n\u2514\u2500\u2500 node.pem\n\n1 directory, 2 files\n"})}),"\n",(0,o.jsx)(n.p,{children:"Considering the above for our example, you would have to run the following command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv /my-keystore-backup /home//.lightning/keystore\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"tip",children:(0,o.jsxs)(n.p,{children:["Remember to replace the ",(0,o.jsx)(n.code,{children:""})," with the correct username for the setup. For example, if you have installed the Fleek Network with the username ",(0,o.jsx)(n.code,{children:"lgtn"})," that would be ",(0,o.jsx)(n.code,{children:"/home/lgtn/.lightning/keystore"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["Once moved, remember to start the service, you can learn how to manage the service by reading the section ",(0,o.jsx)(n.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})]})}function i(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(s,{...e})}):s(e)}},6172:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>h,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>g});var o=t(5893),r=t(1151),s=t(3872),i=t(1586),l=t(5979);const a={title:"Restore the keystore",slug:"restore-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},h=void 0,c={id:"Lightning CLI/restore-keystore",title:"Restore the keystore",description:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only.",source:"@site/references/Lightning CLI/restore-keystore.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/restore-the-keystore",permalink:"/references/Lightning CLI/restore-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/restore-keystore.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"keystore",permalink:"/references/tags/keystore"},{label:"backup",permalink:"/references/tags/backup"},{label:"restore",permalink:"/references/tags/restore"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Restore the keystore",slug:"restore-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},sidebar:"defaultSidebar",previous:{title:"Permission denied (os error 13)",permalink:"/references/Lightning CLI/permission-denied-os-error-13"},next:{title:"Uninstall Lightning Node",permalink:"/references/Lightning CLI/uninstall-lightning-node"}},d={},g=[{value:"Switch user",id:"switch-user",level:2},{value:"Change directory to user home",id:"change-directory-to-user-home",level:2},{value:"Clear the config.toml",id:"clear-the-configtoml",level:2},{value:"Create a new config.toml",id:"create-a-new-configtoml",level:2},{value:"Update the config.toml with user home path",id:"update-the-configtoml-with-user-home-path",level:2},{value:"Restoring the keystore",id:"restoring-the-keystore",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.admonition,{type:"caution",children:(0,o.jsx)(n.p,{children:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."})}),"\n",(0,o.jsx)(n.h2,{id:"switch-user",children:"Switch user"}),"\n",(0,o.jsxs)(n.p,{children:["Switch to the correct username you have used to install and set up the Fleek Network Lightning. For example, let's say that the username is ",(0,o.jsx)(n.code,{children:"lgtn"}),". The command you'd have to run would be:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"su lgtn\n"})}),"\n",(0,o.jsx)(n.h2,{id:"change-directory-to-user-home",children:"Change directory to user home"}),"\n",(0,o.jsxs)(n.p,{children:["Change directory to the user you have used to install and set up the Fleek Network Lightning. For example, if you have used the username ",(0,o.jsx)(n.code,{children:"lgtn"})," the command would be:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"cd $HOME\n"})}),"\n",(0,o.jsx)(n.p,{children:"In other words:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"cd /home/lgtn\n"})}),"\n",(0,o.jsx)(n.h2,{id:"clear-the-configtoml",children:"Clear the config.toml"}),"\n",(0,o.jsxs)(n.p,{children:["You should can delete, backup or move the ",(0,o.jsx)(n.code,{children:"config.toml"})," file in order to reset it."]}),"\n",(0,o.jsx)(n.p,{children:"It might be necessary to, if your configuration, e.g. is corrupted, or you want to reset it for any other reason."}),"\n",(0,o.jsx)(n.p,{children:"To move or backup, run:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"mv ~/.lightning/config.toml ~/.lightning/config.toml.backup\n"})}),"\n",(0,o.jsx)(n.p,{children:"If you don't have a use-case for the backup, delete the file. To delete, run the command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"rm ~/.lightning/config.toml\n"})}),"\n",(0,o.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,o.jsxs)(n.p,{children:["You should have switched to the correct username. If you haven't done it, when stating ",(0,o.jsx)(n.code,{children:"~"})," that will refer to the current username home, which can be anything other than the correct username! Make sure you have switched to the correct username used during the installation and set up of Fleek Network Lightning to avoid confusion and issues."]})}),"\n",(0,o.jsx)(n.h2,{id:"create-a-new-configtoml",children:"Create a new config.toml"}),"\n",(0,o.jsx)(n.p,{children:"A new configuration file can be created by running the following command:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:"lgtn print-config --default > ~/.lightning/config.toml\n"})}),"\n",(0,o.jsx)(n.h2,{id:"update-the-configtoml-with-user-home-path",children:"Update the config.toml with user home path"}),"\n",(0,o.jsx)(i.ZP,{}),"\n",(0,o.jsx)(n.h2,{id:"restoring-the-keystore",children:"Restoring the keystore"}),"\n",(0,o.jsx)(l.ZP,{}),"\n",(0,o.jsxs)(n.p,{children:["For a more in depth or step-by-step instructions read the guide ",(0,o.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,o.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>r});t(7294);var o=t(5893);const r=e=>{let{image:n,name:t,title:r,url:s,communityMember:i=!1}=e;return(0,o.jsx)("section",{className:"author_card",children:(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"avatar",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:t,children:(0,o.jsx)("img",{src:n,alt:t})})}),(0,o.jsxs)("div",{children:[(0,o.jsx)("span",{className:"name",children:(0,o.jsx)("a",{href:s,target:"_blank",alt:t,children:t})}),(0,o.jsx)("span",{className:"title",children:r}),(0,o.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,o.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>i});var o=t(7294);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2730e145.c1bd76ce.js b/assets/js/2730e145.adec3d4f.js similarity index 99% rename from assets/js/2730e145.c1bd76ce.js rename to assets/js/2730e145.adec3d4f.js index b7b0fc5c3..2141ad143 100644 --- a/assets/js/2730e145.c1bd76ce.js +++ b/assets/js/2730e145.adec3d4f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7147],{5450:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>m,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var r=i(5893),s=i(1151),t=i(3872);const o={title:"Permission denied (os error 13)",slug:"permission-denied-os-error-13",hide_title:!0,tags:["permissions"]},a=void 0,d={id:"Lightning CLI/permission-denied-os-error-13",title:"Permission denied (os error 13)",description:"Ownership and file permissions",source:"@site/references/Lightning CLI/permission-denied-os-error-13.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/permission-denied-os-error-13",permalink:"/references/Lightning CLI/permission-denied-os-error-13",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/permission-denied-os-error-13.md",tags:[{label:"permissions",permalink:"/references/tags/permissions"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Permission denied (os error 13)",slug:"permission-denied-os-error-13",hide_title:!0,tags:["permissions"]},sidebar:"defaultSidebar",previous:{title:"Node secret key does not exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist"},next:{title:"Restore the keystore",permalink:"/references/Lightning CLI/restore-the-keystore"}},c={},l=[{value:"Ownership and file permissions",id:"ownership-and-file-permissions",level:2},{value:"Override the TMPDIR",id:"override-the-tmpdir",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"ownership-and-file-permissions",children:"Ownership and file permissions"}),"\n",(0,r.jsxs)(n.p,{children:["When running the Lightning CLI, the user who's in control can delegate to ",(0,r.jsx)(n.strong,{children:"root"})," via ",(0,r.jsx)(n.strong,{children:"sudo"}),". Depending on how the Fleek Networking Lightning CLI was installed, this might cause some confusion, which is better explained by reading the reference ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/keys-not-found",children:"Keys not found"}),", which illustrates a situation where a user gets an error message about the wrong location of a system path (keystore)."]}),"\n",(0,r.jsxs)(n.p,{children:["Some reasons why the ",(0,r.jsx)(n.code,{children:"Permission denied (os error 13)"})," might occur are related to:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["The Fleek Network Lightning CLI process trying to write to a ",(0,r.jsx)(n.code,{children:".lightning"})," stored in a non permitted location"]}),"\n",(0,r.jsxs)(n.li,{children:["The Fleek Network Lightning CLI process trying to write to ",(0,r.jsx)(n.code,{children:"/tmp"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The most common issue can be fixed by reading the section ",(0,r.jsx)(n.a,{href:"#override-the-tmpdir",children:"Override the TMPDIR"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"override-the-tmpdir",children:"Override the TMPDIR"}),"\n",(0,r.jsx)(n.p,{children:"The Fleek Network Lightning process requires writing to a temporary directory. As the process requires permissions, this might fail as demonstrated by some of the output logs we have below."}),"\n",(0,r.jsx)(n.p,{children:"a) A permission denied error message"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"Permission denied (os error 13)\n"})}),"\n",(0,r.jsx)(n.p,{children:"b) Rust panic error message which includes a permission denied"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"thread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\n"})}),"\n",(0,r.jsx)(n.p,{children:"c) A trace showing the path where this has failed"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[00007fcbe168e764] openat(AT_FDCWD, "/tmp/lightning.log", O_WRONLY|O_CREAT|O_APPEND|O_CLOEXEC, 0666) = -1 EACCES (Permission denied)\n[00007fcbe168ea6f] write(2, "thread \'", 8thread \') = 8\n[00007fcbe168ea6f] write(2, "main", 4main) = 4\n[00007fcbe168ea6f] write(2, "\' panicked at \'", 15\' panicked at \') = 15\n[00007fcbe168ea6f] write(2, "called `Result::unwrap()` on an "..., 114called `Result::unwrap()` on an `Err` value: Os { code: 13, kind: PermissionDenied, message: "Permission denied" }) = 114\n[00007fcbe168ea6f] write(2, "\', ", 3\', ) = 3\n'})}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"/tmp"})," directory should have wide permissions for all applications, but to mitigate any permission issues the user can override the system environment ",(0,r.jsx)(n.code,{children:"TMPDIR"}),". For example, the ",(0,r.jsx)(n.code,{children:"installer"})," and ",(0,r.jsx)(n.code,{children:"update"})," scripts override ",(0,r.jsx)(n.code,{children:"TMPDIR"})," environment variable to ",(0,r.jsx)(n.code,{children:"/var/tmp"})," setting it in the service unit ",(0,r.jsx)(n.code,{children:"Environment="}),"."]})}),"\n",(0,r.jsxs)(n.p,{children:["The Lightning CLI process is aware of the environment variable TMPDIR, which the operators can override as discussed in the reference for ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code/#update-the-systemd-service-unit",children:"Update the System service unit"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["In short, it requires you to include a ",(0,r.jsx)(n.code,{children:"Environment="})," value of ",(0,r.jsx)(n.code,{children:"TMPDIR=/var/tmp"})," as follows:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"[Service]\n...\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"attention",type:"caution",children:(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," service unit file presented here is a shorter version for simplicity. Do not replace your service unit file with the shorter content version presented here."]})}),"\n",(0,r.jsx)(t.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,i)=>{i.d(n,{Z:()=>s});i(7294);var r=i(5893);const s=e=>{let{image:n,name:i,title:s,url:t,communityMember:o=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:t,target:"_blank",alt:i,children:(0,r.jsx)("img",{src:n,alt:i})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:t,target:"_blank",alt:i,children:i})}),(0,r.jsx)("span",{className:"title",children:s}),(0,r.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(7294);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7147],{5450:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>m,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var r=i(5893),s=i(1151),t=i(3872);const o={title:"Permission denied (os error 13)",slug:"permission-denied-os-error-13",hide_title:!0,tags:["permissions"]},a=void 0,d={id:"Lightning CLI/permission-denied-os-error-13",title:"Permission denied (os error 13)",description:"Ownership and file permissions",source:"@site/references/Lightning CLI/permission-denied-os-error-13.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/permission-denied-os-error-13",permalink:"/references/Lightning CLI/permission-denied-os-error-13",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/permission-denied-os-error-13.md",tags:[{label:"permissions",permalink:"/references/tags/permissions"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Permission denied (os error 13)",slug:"permission-denied-os-error-13",hide_title:!0,tags:["permissions"]},sidebar:"defaultSidebar",previous:{title:"Node secret key does not exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist"},next:{title:"Restore the keystore",permalink:"/references/Lightning CLI/restore-the-keystore"}},c={},l=[{value:"Ownership and file permissions",id:"ownership-and-file-permissions",level:2},{value:"Override the TMPDIR",id:"override-the-tmpdir",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"ownership-and-file-permissions",children:"Ownership and file permissions"}),"\n",(0,r.jsxs)(n.p,{children:["When running the Lightning CLI, the user who's in control can delegate to ",(0,r.jsx)(n.strong,{children:"root"})," via ",(0,r.jsx)(n.strong,{children:"sudo"}),". Depending on how the Fleek Networking Lightning CLI was installed, this might cause some confusion, which is better explained by reading the reference ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/keys-not-found",children:"Keys not found"}),", which illustrates a situation where a user gets an error message about the wrong location of a system path (keystore)."]}),"\n",(0,r.jsxs)(n.p,{children:["Some reasons why the ",(0,r.jsx)(n.code,{children:"Permission denied (os error 13)"})," might occur are related to:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["The Fleek Network Lightning CLI process trying to write to a ",(0,r.jsx)(n.code,{children:".lightning"})," stored in a non permitted location"]}),"\n",(0,r.jsxs)(n.li,{children:["The Fleek Network Lightning CLI process trying to write to ",(0,r.jsx)(n.code,{children:"/tmp"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["The most common issue can be fixed by reading the section ",(0,r.jsx)(n.a,{href:"#override-the-tmpdir",children:"Override the TMPDIR"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"override-the-tmpdir",children:"Override the TMPDIR"}),"\n",(0,r.jsx)(n.p,{children:"The Fleek Network Lightning process requires writing to a temporary directory. As the process requires permissions, this might fail as demonstrated by some of the output logs we have below."}),"\n",(0,r.jsx)(n.p,{children:"a) A permission denied error message"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"Permission denied (os error 13)\n"})}),"\n",(0,r.jsx)(n.p,{children:"b) Rust panic error message which includes a permission denied"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"thread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\nthread 'main' panicked at 'called Result::unwrap() on an Err value: Os { code: 13, kind: PermissionDenied, message: \"Permission denied\" }', core/node/src/cli.rs:181:18\nnote: run with RUST_BACKTRACE=1 environment variable to display a backtrace\n"})}),"\n",(0,r.jsx)(n.p,{children:"c) A trace showing the path where this has failed"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[00007fcbe168e764] openat(AT_FDCWD, "/tmp/lightning.log", O_WRONLY|O_CREAT|O_APPEND|O_CLOEXEC, 0666) = -1 EACCES (Permission denied)\n[00007fcbe168ea6f] write(2, "thread \'", 8thread \') = 8\n[00007fcbe168ea6f] write(2, "main", 4main) = 4\n[00007fcbe168ea6f] write(2, "\' panicked at \'", 15\' panicked at \') = 15\n[00007fcbe168ea6f] write(2, "called `Result::unwrap()` on an "..., 114called `Result::unwrap()` on an `Err` value: Os { code: 13, kind: PermissionDenied, message: "Permission denied" }) = 114\n[00007fcbe168ea6f] write(2, "\', ", 3\', ) = 3\n'})}),"\n",(0,r.jsx)(n.admonition,{type:"tip",children:(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"/tmp"})," directory should have wide permissions for all applications, but to mitigate any permission issues the user can override the system environment ",(0,r.jsx)(n.code,{children:"TMPDIR"}),". For example, the ",(0,r.jsx)(n.code,{children:"installer"})," and ",(0,r.jsx)(n.code,{children:"update"})," scripts override ",(0,r.jsx)(n.code,{children:"TMPDIR"})," environment variable to ",(0,r.jsx)(n.code,{children:"/var/tmp"})," setting it in the service unit ",(0,r.jsx)(n.code,{children:"Environment="}),"."]})}),"\n",(0,r.jsxs)(n.p,{children:["The Lightning CLI process is aware of the environment variable TMPDIR, which the operators can override as discussed in the reference for ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code/#update-the-systemd-service-unit",children:"Update the System service unit"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["In short, it requires you to include a ",(0,r.jsx)(n.code,{children:"Environment="})," value of ",(0,r.jsx)(n.code,{children:"TMPDIR=/var/tmp"})," as follows:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"[Service]\n...\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"attention",type:"caution",children:(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," service unit file presented here is a shorter version for simplicity. Do not replace your service unit file with the shorter content version presented here."]})}),"\n",(0,r.jsx)(t.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,i)=>{i.d(n,{Z:()=>s});i(7294);var r=i(5893);const s=e=>{let{image:n,name:i,title:s,url:t,communityMember:o=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:t,target:"_blank",alt:i,children:(0,r.jsx)("img",{src:n,alt:i})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:t,target:"_blank",alt:i,children:i})}),(0,r.jsx)("span",{className:"title",children:s}),(0,r.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(7294);const s={},t=r.createContext(s);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29b62a39.b6b221f6.js b/assets/js/29b62a39.333f4be5.js similarity index 97% rename from assets/js/29b62a39.b6b221f6.js rename to assets/js/29b62a39.333f4be5.js index bfeef93b3..70496a536 100644 --- a/assets/js/29b62a39.b6b221f6.js +++ b/assets/js/29b62a39.333f4be5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1498],{181:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>u});var n=s(5893),i=s(1151);const o=s.p+"assets/images/banner-guides-cd76f6e8aac3594bb5d072a564e0e277.png",a={title:"About guides",hide_title:!0,sidebar_position:1,tags:["Guides","Help","Fleek Network"]},r=void 0,d={id:"index",title:"About guides",description:"The guides provide step-by-step instructions and descriptions to help understand how and why you'd have to do or execute certain commands or processes.",source:"@site/guides/index.md",sourceDirName:".",slug:"/",permalink:"/guides/",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/index.md",tags:[{label:"Guides",permalink:"/guides/tags/guides"},{label:"Help",permalink:"/guides/tags/help"},{label:"Fleek Network",permalink:"/guides/tags/fleek-network"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",sidebarPosition:1,frontMatter:{title:"About guides",hide_title:!0,sidebar_position:1,tags:["Guides","Help","Fleek Network"]},sidebar:"defaultSidebar",next:{title:"Getting Started",permalink:"/guides/Node Operators/getting-started"}},c={},u=[];function l(e){const t={a:"a",p:"p",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("img",{className:"banner",src:o}),"\n",(0,n.jsx)(t.p,{children:"The guides provide step-by-step instructions and descriptions to help understand how and why you'd have to do or execute certain commands or processes."}),"\n",(0,n.jsxs)(t.p,{children:["It differs from the ",(0,n.jsx)(t.a,{href:"/references",children:"references"})," documentation which serves as a quick direct breakdown of commands and processes without much explanation, as the name implies."]}),"\n",(0,n.jsx)(t.p,{children:"To start, find guides by consulting the available categories to locate the content on the sidebar. Our guides are also available as a result when using the search feature located at the very top of the documentation site."})]})}function p(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1151:(e,t,s)=>{s.d(t,{Z:()=>r,a:()=>a});var n=s(7294);const i={},o=n.createContext(i);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1498],{181:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>u});var n=s(5893),i=s(1151);const o=s.p+"assets/images/banner-guides-cd76f6e8aac3594bb5d072a564e0e277.png",a={title:"About guides",hide_title:!0,sidebar_position:1,tags:["Guides","Help","Fleek Network"]},r=void 0,d={id:"index",title:"About guides",description:"The guides provide step-by-step instructions and descriptions to help understand how and why you'd have to do or execute certain commands or processes.",source:"@site/guides/index.md",sourceDirName:".",slug:"/",permalink:"/guides/",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/index.md",tags:[{label:"Guides",permalink:"/guides/tags/guides"},{label:"Help",permalink:"/guides/tags/help"},{label:"Fleek Network",permalink:"/guides/tags/fleek-network"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",sidebarPosition:1,frontMatter:{title:"About guides",hide_title:!0,sidebar_position:1,tags:["Guides","Help","Fleek Network"]},sidebar:"defaultSidebar",next:{title:"Getting Started",permalink:"/guides/Node Operators/getting-started"}},c={},u=[];function l(e){const t={a:"a",p:"p",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("img",{className:"banner",src:o}),"\n",(0,n.jsx)(t.p,{children:"The guides provide step-by-step instructions and descriptions to help understand how and why you'd have to do or execute certain commands or processes."}),"\n",(0,n.jsxs)(t.p,{children:["It differs from the ",(0,n.jsx)(t.a,{href:"/references",children:"references"})," documentation which serves as a quick direct breakdown of commands and processes without much explanation, as the name implies."]}),"\n",(0,n.jsx)(t.p,{children:"To start, find guides by consulting the available categories to locate the content on the sidebar. Our guides are also available as a result when using the search feature located at the very top of the documentation site."})]})}function p(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1151:(e,t,s)=>{s.d(t,{Z:()=>r,a:()=>a});var n=s(7294);const i={},o=n.createContext(i);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/29b83576.57da8952.js b/assets/js/29b83576.29335de2.js similarity index 99% rename from assets/js/29b83576.57da8952.js rename to assets/js/29b83576.29335de2.js index 4c001272b..4d7d4bf5e 100644 --- a/assets/js/29b83576.57da8952.js +++ b/assets/js/29b83576.29335de2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1510],{7003:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>o,metadata:()=>l,toc:()=>h});var r=t(5893),s=t(1151),i=t(3872);const o={title:"Backing up the keystore",slug:"backing-up-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},a=void 0,l={id:"Lightning CLI/keystore-backup",title:"Backing up the keystore",description:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only.",source:"@site/references/Lightning CLI/keystore-backup.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/backing-up-the-keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/keystore-backup.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"keystore",permalink:"/references/tags/keystore"},{label:"backup",permalink:"/references/tags/backup"},{label:"restore",permalink:"/references/tags/restore"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Backing up the keystore",slug:"backing-up-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},sidebar:"defaultSidebar",previous:{title:"Keys not found",permalink:"/references/Lightning CLI/keys-not-found"},next:{title:"Node secret key does not exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist"}},c={},h=[{value:"Keystore pathname",id:"keystore-pathname",level:2},{value:"Configuration file settings",id:"configuration-file-settings",level:2},{value:"Loading the configuration file on runtime",id:"loading-the-configuration-file-on-runtime",level:2},{value:"Low security backup",id:"low-security-backup",level:2},{value:"Higher security",id:"higher-security",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.admonition,{type:"caution",children:(0,r.jsx)(n.p,{children:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."})}),"\n",(0,r.jsx)(n.h2,{id:"keystore-pathname",children:"Keystore pathname"}),"\n",(0,r.jsxs)(n.p,{children:["The default location for the keystore is in the user home. The $HOME or ",(0,r.jsx)(n.code,{children:"~"})," refers to the user home, as such consider the logged-in username."]}),"\n",(0,r.jsx)(n.p,{children:"To Check the user you are logged in with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default location for the keystore is:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"$HOME/.lightning/keystore\n"})}),"\n",(0,r.jsx)(n.h2,{id:"configuration-file-settings",children:"Configuration file settings"}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"config.toml"})," should have some and more of the following properties and values that are used to locate crucial files, such as the consensus and node keys of the keystore."]}),"\n",(0,r.jsxs)(n.p,{children:["Here's an incomplete example of how the ",(0,r.jsx)(n.code,{children:"config.toml"})," looks like:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[BLANK]\n...\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n...\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n...\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n...\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n...\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n...\n'})}),"\n",(0,r.jsxs)(n.p,{children:["If you've followed the installation recommendations, it's very likely that you'll have the username path defined at the base of the pathnames declared in the properties, such as the following except instead of ",(0,r.jsx)(n.code,{children:""})," you'll have your username:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[signer]\nconsensus_key_path = "/home//.lightning/keystore/consensus.pem"\nnode_key_path = "/home//.lightning/keystore/node.pem"\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"config.toml"})," if loaded on Lightning node process runtime, will pick the desired paths declared in the file."]}),"\n",(0,r.jsx)(n.h2,{id:"loading-the-configuration-file-on-runtime",children:"Loading the configuration file on runtime"}),"\n",(0,r.jsxs)(n.p,{children:["Use the configuration flag ",(0,r.jsx)(n.code,{children:"-c"})," to pass the configuration ",(0,r.jsx)(n.code,{children:"config.toml"})," path:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home//.lightning/config.toml run\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Replace the ",(0,r.jsx)(n.code,{children:""})," with the correct username, where the config is located."]}),"\n",(0,r.jsxs)(n.p,{children:["Executing the subcommand ",(0,r.jsx)(n.code,{children:"run"})," without the configuration flag ",(0,r.jsx)(n.code,{children:"-c"}),", doesn't mean that it'll locate the desired ",(0,r.jsx)(n.code,{children:"config.toml"}),", as it'll default to ",(0,r.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),", e.g. if you were logged in with ",(0,r.jsx)(n.strong,{children:"root"}),", that'd be ",(0,r.jsx)(n.code,{children:"/root/.lightning/config.toml"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"low-security-backup",children:"Low security backup"}),"\n",(0,r.jsxs)(n.p,{children:["To zip and encrypt the ",(0,r.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory run:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (remember)\nzip --encrypt -r keystore.zip.enc $HOME/.lightning/keystore\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To unzip and decrypt the ",(0,r.jsx)(n.code,{children:"keystore.zip.enc"}),", you'd run:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (recall)\nunzip keystore.zip.enc -d $HOME/.lightning/keystore\n"})}),"\n",(0,r.jsx)(n.h2,{id:"higher-security",children:"Higher security"}),"\n",(0,r.jsxs)(n.p,{children:["Create a ",(0,r.jsx)(n.code,{children:"tarbar"})," by executing:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'tar -cf "keystore.tar" $HOME/.lightning/keystore\n'})}),"\n",(0,r.jsx)(n.p,{children:"The encryption command is:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --symmetric --cipher-algo AES256 keystore.tar\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To decrypt the ",(0,r.jsx)(n.code,{children:"keystore.tar.asc"})," file, enter:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --output keystore.tar --decrypt keystore.tar.asc\n"})}),"\n",(0,r.jsx)(n.p,{children:"Create a temporary directory to extract the tar archive with the original full pathname."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"mkdir $HOME/tar_keystore_extract\n"})}),"\n",(0,r.jsx)(n.p,{children:"Now, run the command to extract to the target directory, as follows:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"tar -xf keystore.tar -C $HOME/tar_keystore_extract\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Locate the extracted files in ",(0,r.jsx)(n.code,{children:"$HOME/tar_keystore_extract"}),", which should look like ",(0,r.jsx)(n.code,{children:"$HOME/tar_keystore/home//.lightning/keystore"})]}),"\n",(0,r.jsxs)(n.p,{children:["For a more in depth or step-by-step instructions read the guide ",(0,r.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,r.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var r=t(5893);const s=e=>{let{image:n,name:t,title:s,url:i,communityMember:o=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,r.jsx)("img",{src:n,alt:t})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,r.jsx)("span",{className:"title",children:s}),(0,r.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var r=t(7294);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1510],{7003:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>o,metadata:()=>l,toc:()=>h});var r=t(5893),s=t(1151),i=t(3872);const o={title:"Backing up the keystore",slug:"backing-up-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},a=void 0,l={id:"Lightning CLI/keystore-backup",title:"Backing up the keystore",description:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only.",source:"@site/references/Lightning CLI/keystore-backup.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/backing-up-the-keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/keystore-backup.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"keystore",permalink:"/references/tags/keystore"},{label:"backup",permalink:"/references/tags/backup"},{label:"restore",permalink:"/references/tags/restore"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Backing up the keystore",slug:"backing-up-the-keystore",hide_title:!0,tags:["references","help","keystore","backup","restore"]},sidebar:"defaultSidebar",previous:{title:"Keys not found",permalink:"/references/Lightning CLI/keys-not-found"},next:{title:"Node secret key does not exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist"}},c={},h=[{value:"Keystore pathname",id:"keystore-pathname",level:2},{value:"Configuration file settings",id:"configuration-file-settings",level:2},{value:"Loading the configuration file on runtime",id:"loading-the-configuration-file-on-runtime",level:2},{value:"Low security backup",id:"low-security-backup",level:2},{value:"Higher security",id:"higher-security",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.admonition,{type:"caution",children:(0,r.jsx)(n.p,{children:"The security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."})}),"\n",(0,r.jsx)(n.h2,{id:"keystore-pathname",children:"Keystore pathname"}),"\n",(0,r.jsxs)(n.p,{children:["The default location for the keystore is in the user home. The $HOME or ",(0,r.jsx)(n.code,{children:"~"})," refers to the user home, as such consider the logged-in username."]}),"\n",(0,r.jsx)(n.p,{children:"To Check the user you are logged in with:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),"\n",(0,r.jsx)(n.p,{children:"The default location for the keystore is:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"$HOME/.lightning/keystore\n"})}),"\n",(0,r.jsx)(n.h2,{id:"configuration-file-settings",children:"Configuration file settings"}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"config.toml"})," should have some and more of the following properties and values that are used to locate crucial files, such as the consensus and node keys of the keystore."]}),"\n",(0,r.jsxs)(n.p,{children:["Here's an incomplete example of how the ",(0,r.jsx)(n.code,{children:"config.toml"})," looks like:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[BLANK]\n...\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n...\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n...\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n...\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n...\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n...\n'})}),"\n",(0,r.jsxs)(n.p,{children:["If you've followed the installation recommendations, it's very likely that you'll have the username path defined at the base of the pathnames declared in the properties, such as the following except instead of ",(0,r.jsx)(n.code,{children:""})," you'll have your username:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'[signer]\nconsensus_key_path = "/home//.lightning/keystore/consensus.pem"\nnode_key_path = "/home//.lightning/keystore/node.pem"\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"config.toml"})," if loaded on Lightning node process runtime, will pick the desired paths declared in the file."]}),"\n",(0,r.jsx)(n.h2,{id:"loading-the-configuration-file-on-runtime",children:"Loading the configuration file on runtime"}),"\n",(0,r.jsxs)(n.p,{children:["Use the configuration flag ",(0,r.jsx)(n.code,{children:"-c"})," to pass the configuration ",(0,r.jsx)(n.code,{children:"config.toml"})," path:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home//.lightning/config.toml run\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Replace the ",(0,r.jsx)(n.code,{children:""})," with the correct username, where the config is located."]}),"\n",(0,r.jsxs)(n.p,{children:["Executing the subcommand ",(0,r.jsx)(n.code,{children:"run"})," without the configuration flag ",(0,r.jsx)(n.code,{children:"-c"}),", doesn't mean that it'll locate the desired ",(0,r.jsx)(n.code,{children:"config.toml"}),", as it'll default to ",(0,r.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),", e.g. if you were logged in with ",(0,r.jsx)(n.strong,{children:"root"}),", that'd be ",(0,r.jsx)(n.code,{children:"/root/.lightning/config.toml"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"low-security-backup",children:"Low security backup"}),"\n",(0,r.jsxs)(n.p,{children:["To zip and encrypt the ",(0,r.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory run:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (remember)\nzip --encrypt -r keystore.zip.enc $HOME/.lightning/keystore\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To unzip and decrypt the ",(0,r.jsx)(n.code,{children:"keystore.zip.enc"}),", you'd run:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (recall)\nunzip keystore.zip.enc -d $HOME/.lightning/keystore\n"})}),"\n",(0,r.jsx)(n.h2,{id:"higher-security",children:"Higher security"}),"\n",(0,r.jsxs)(n.p,{children:["Create a ",(0,r.jsx)(n.code,{children:"tarbar"})," by executing:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'tar -cf "keystore.tar" $HOME/.lightning/keystore\n'})}),"\n",(0,r.jsx)(n.p,{children:"The encryption command is:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --symmetric --cipher-algo AES256 keystore.tar\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To decrypt the ",(0,r.jsx)(n.code,{children:"keystore.tar.asc"})," file, enter:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --output keystore.tar --decrypt keystore.tar.asc\n"})}),"\n",(0,r.jsx)(n.p,{children:"Create a temporary directory to extract the tar archive with the original full pathname."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"mkdir $HOME/tar_keystore_extract\n"})}),"\n",(0,r.jsx)(n.p,{children:"Now, run the command to extract to the target directory, as follows:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"tar -xf keystore.tar -C $HOME/tar_keystore_extract\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Locate the extracted files in ",(0,r.jsx)(n.code,{children:"$HOME/tar_keystore_extract"}),", which should look like ",(0,r.jsx)(n.code,{children:"$HOME/tar_keystore/home//.lightning/keystore"})]}),"\n",(0,r.jsxs)(n.p,{children:["For a more in depth or step-by-step instructions read the guide ",(0,r.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,r.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var r=t(5893);const s=e=>{let{image:n,name:t,title:s,url:i,communityMember:o=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,r.jsx)("img",{src:n,alt:t})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,r.jsx)("span",{className:"title",children:s}),(0,r.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var r=t(7294);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/40aeb86f.fce7036d.js b/assets/js/40aeb86f.488d6a51.js similarity index 99% rename from assets/js/40aeb86f.fce7036d.js rename to assets/js/40aeb86f.488d6a51.js index 0ef86031b..657fe2288 100644 --- a/assets/js/40aeb86f.fce7036d.js +++ b/assets/js/40aeb86f.488d6a51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[4402],{1586:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,s.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,s.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Replace the ",(0,s.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if your username is ",(0,s.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Once modified, you can run a ",(0,s.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,s.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,s.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},1761:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["The flag ",(0,s.jsx)(n.code,{children:"-c"})," in the ",(0,s.jsx)(n.code,{children:"lightning.service"})," ",(0,s.jsx)(n.strong,{children:"ExecStart"}),", is to provide the toml configuration file path e.g. defaults to ",(0,s.jsx)(n.code,{children:"~/.lightning/config.toml"}),". This is to avoid the path being determined dynamically (given path base ~ or $HOME), as users might control the systemctl service as a ",(0,s.jsx)(n.strong,{children:"user"})," or ",(0,s.jsx)(n.strong,{children:"sudoer"}),". For example, a ",(0,s.jsx)(n.strong,{children:"sudoer"})," would have the ",(0,s.jsx)(n.strong,{children:"configuration"})," set to ",(0,s.jsx)(n.code,{children:"/root/.lightning/config.toml"})," or ",(0,s.jsx)(n.code,{children:"/home/username/.lightning/config.toml"})," depending on using ",(0,s.jsx)(n.strong,{children:"sudo"})," which might cause some confusion to some users."]})})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},4405:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["You should be following the ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user-1",children:"create a user"})," recommendation. For our example, we have the username ",(0,s.jsx)(n.code,{children:"lgtn"}),"."]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["If you have chosen a different username, replace ",(0,s.jsx)(n.code,{children:"lgtn"})," by the correct username you have selected."]})}),"\n",(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ",(0,s.jsx)(n.code,{children:"~"})," in the config file ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"}),". Here's an example using ",(0,s.jsx)(n.code,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"config.toml"})," example below is a shorter version of what you'll encounter, yours might look different. We do this to keep the guide simple to read. Do not copy and replace with the version demonstrated here."]})}),"\n",(0,s.jsxs)(n.p,{children:["Once changed, all the instances of ",(0,s.jsx)(n.code,{children:"~/"})," should be replaced by your user path e.g. ",(0,s.jsx)(n.code,{children:"/home/lgtn/"}),". For our example, the output would look like the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "/home/lgtn/.lightning/data/app_db"\n\n[consensus]\nstore_path = "/home/lgtn/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "/home/lgtn/.lightning/blockstore"\n\n[resolver]\nstore_path = "/home/lgtn/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},2382:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>h,default:()=>m,frontMatter:()=>c,metadata:()=>d,toc:()=>u});var s=t(5893),o=t(1151),i=t(3872),r=t(4405),l=t(1761),a=t(1586);const c={title:"Update CLI from source code",slug:"update-cli-from-source-code",hide_title:!0,tags:["references","help","update","upgrade","fix"]},h=void 0,d={id:"Lightning CLI/update-cli-from-source-code",title:"Update CLI from source code",description:"Although the step-by-step instructions described here are simple to follow, this process is available as an automated script. To use it execute the following command in your server terminal and follow the instructions:",source:"@site/references/Lightning CLI/update-cli-from-source-code.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/update-cli-from-source-code",permalink:"/references/Lightning CLI/update-cli-from-source-code",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/update-cli-from-source-code.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"update",permalink:"/references/tags/update"},{label:"upgrade",permalink:"/references/tags/upgrade"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Update CLI from source code",slug:"update-cli-from-source-code",hide_title:!0,tags:["references","help","update","upgrade","fix"]},sidebar:"defaultSidebar",previous:{title:"Uninstall Lightning Node",permalink:"/references/Lightning CLI/uninstall-lightning-node"},next:{title:"Service keeps running after shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown"}},g={},u=[{value:"Switch to the installation user",id:"switch-to-the-installation-user",level:2},{value:"Change directory to the source code",id:"change-directory-to-the-source-code",level:2},{value:"Checkout to branch",id:"checkout-to-branch",level:2},{value:"Pull the latest changes",id:"pull-the-latest-changes",level:2},{value:"Build binary from the source",id:"build-binary-from-the-source",level:2},{value:"Update the symlink",id:"update-the-symlink",level:2},{value:"Set user path in config.toml",id:"set-user-path-in-configtoml",level:2},{value:"Update the systemd service unit",id:"update-the-systemd-service-unit",level:2},{value:"Clear the data",id:"clear-the-data",level:2},{value:"Update the config.toml",id:"update-the-configtoml",level:2},{value:"Update the config.toml with user home path",id:"update-the-configtoml-with-user-home-path",level:2},{value:"Restart the service",id:"restart-the-service",level:2},{value:"Health checkup",id:"health-checkup",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsx)(n.p,{children:"Although the step-by-step instructions described here are simple to follow, this process is available as an automated script. To use it execute the following command in your server terminal and follow the instructions:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/update | bash\n"})})]}),"\n",(0,s.jsx)(n.h2,{id:"switch-to-the-installation-user",children:"Switch to the installation user"}),"\n",(0,s.jsx)(n.p,{children:"Switch to the username you've used throughout the installation process."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su \n"})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if you used the username ",(0,s.jsx)(n.code,{children:"lgtn"})," it'll look like the following command:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,s.jsx)(n.h2,{id:"change-directory-to-the-source-code",children:"Change directory to the source code"}),"\n",(0,s.jsxs)(n.p,{children:["If you have installed it via the recommended process or instructions, then the default location where the ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"source code"})," is stored is ",(0,s.jsx)(n.code,{children:"~/fleek-network/lightning"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Notice that we use ",(0,s.jsx)(n.code,{children:"~"}),", which refers to ",(0,s.jsx)(n.code,{children:"$HOME"}),". You must use the username used for the installation process. For example, on ",(0,s.jsx)(n.a,{href:"/docs/node/requirements#server",children:"Ubuntu"})," if you use the username ",(0,s.jsx)(n.code,{children:"lgtn"}),", the pathname for ",(0,s.jsx)(n.code,{children:"$HOME"})," is ",(0,s.jsx)(n.code,{children:"/home/lgtn"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"checkout-to-branch",children:"Checkout to branch"}),"\n",(0,s.jsxs)(n.p,{children:["Make sure that you are checked in to the correct branch. For the current testnet phase that'd be ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),". If you use any other branch name, your node will not function correctly. Use the branch name ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git checkout testnet-alpha-1\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["We try to update our documentation promptly but sometimes are a bit behind on any changes we might make in real-time. If you find any typos, such as the wrong branch name, help us by letting us know! Find us in Fleek Network section of our ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"pull-the-latest-changes",children:"Pull the latest changes"}),"\n",(0,s.jsxs)(n.p,{children:["Before make sure that you stash or clear any changes you may have in the working directory, as otherwise, ",(0,s.jsx)(n.code,{children:"git"})," will let you know about local changes\u2013if you'd like to learn more about it read the ",(0,s.jsx)(n.a,{href:"https://git-scm.com/docs/git-stash",children:"git stash document"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["A quick way to clean is to ",(0,s.jsx)(n.code,{children:"stash"})," the changes, for example:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git stash \n"})}),"\n",(0,s.jsxs)(n.p,{children:["To pull the latest changes use the ",(0,s.jsx)(n.code,{children:"git pull"})," command, as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git pull origin testnet-alpha-1\n"})}),"\n",(0,s.jsx)(n.p,{children:"Alternatively, to have to stash and pull, you can reset the repository to the origin."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git fetch origin testnet-alpha-1\ngit reset --hard origin/testnet-alpha-1\ngit clean -f\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["We are using the branch named ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),", which is specific to the early testnet launch. Change to the correct branch name according to needs. For example, in the future the mainnet version will go on branch name ",(0,s.jsx)(n.code,{children:"main"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"build-binary-from-the-source",children:"Build binary from the source"}),"\n",(0,s.jsx)(n.p,{children:"To build the binary from the source code, we execute the cargo build command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-symlink",children:"Update the symlink"}),"\n",(0,s.jsx)(n.p,{children:"Start by removing the existing one:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sudo rm -f "/usr/local/bin/lgtn"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Create a new symlink that links the new build binary to ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"}),", as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo ln -s ~/fleek-network/lightning/target/release/lightning-node /usr/local/bin/lgtn\n"})}),"\n",(0,s.jsx)(n.h2,{id:"set-user-path-in-configtoml",children:"Set user path in config.toml"}),"\n",(0,s.jsx)(r.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"update-the-systemd-service-unit",children:"Update the systemd service unit"}),"\n",(0,s.jsxs)(n.p,{children:["Open and edit the ",(0,s.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," file."]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Replace ",(0,s.jsx)(n.code,{children:""})," with the username. For example, in the ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"documentation"})," we use the username ",(0,s.jsx)(n.code,{children:"lgtn"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Make sure that the ",(0,s.jsx)(n.code,{children:"ExecStart"})," is set correctly"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml -vv run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsx)(l.ZP,{}),"\n",(0,s.jsx)(n.p,{children:"When complete make sure the file is saved. Followed by a systemctl daemon reload:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,s.jsx)(n.h2,{id:"clear-the-data",children:"Clear the data"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"rm -rf ~/.lightning/data\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Depending on how you control the system, this might need ",(0,s.jsx)(n.strong,{children:"sudo"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf ~/.lightning/data\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"update-the-configtoml",children:["Update the ",(0,s.jsx)(n.code,{children:"config.toml"})]}),"\n",(0,s.jsxs)(n.p,{children:["Remove the ",(0,s.jsx)(n.code,{children:"~/.lightning/config.toml"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"rm ~/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Create a new ",(0,s.jsx)(n.code,{children:"config.toml"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lgtn print-config --default > ~/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"update-the-configtoml-with-user-home-path",children:["Update the ",(0,s.jsx)(n.code,{children:"config.toml"})," with user home path"]}),"\n",(0,s.jsx)(a.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"restart-the-service",children:"Restart the service"}),"\n",(0,s.jsxs)(n.p,{children:["Once the cargo build process is completed, you have to restart the service. We're assuming you are using non-root user as ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"recommended"}),", you won't use ",(0,s.jsx)(n.strong,{children:"sudo"})," to start the service. The command will look as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["If you have installed the Fleek Network lightning manually, the ",(0,s.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"installation instructions"})," recommended setting up a systemd service for the Fleek Network process. If you haven't, you're advised to check the instructions provided."]})}),"\n",(0,s.jsx)(n.h2,{id:"health-checkup",children:"Health checkup"}),"\n",(0,s.jsx)(n.p,{children:"Do a quick health check by running:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'curl -w "\\p" localhost:4230/health\n'})}),"\n",(0,s.jsxs)(n.p,{children:["If successful, you should get the response ",(0,s.jsx)(n.code,{children:"running and staked"}),", as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"running and staked\n"})}),"\n",(0,s.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var s=t(5893);const o=e=>{let{image:n,name:t,title:o,url:i,communityMember:r=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,s.jsx)("img",{src:n,alt:t})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>r});var s=t(7294);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[4402],{1586:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,s.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,s.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,s.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Replace the ",(0,s.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,s.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if your username is ",(0,s.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Once modified, you can run a ",(0,s.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,s.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,s.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},1761:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={admonition:"admonition",code:"code",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsxs)(n.p,{children:["The flag ",(0,s.jsx)(n.code,{children:"-c"})," in the ",(0,s.jsx)(n.code,{children:"lightning.service"})," ",(0,s.jsx)(n.strong,{children:"ExecStart"}),", is to provide the toml configuration file path e.g. defaults to ",(0,s.jsx)(n.code,{children:"~/.lightning/config.toml"}),". This is to avoid the path being determined dynamically (given path base ~ or $HOME), as users might control the systemctl service as a ",(0,s.jsx)(n.strong,{children:"user"})," or ",(0,s.jsx)(n.strong,{children:"sudoer"}),". For example, a ",(0,s.jsx)(n.strong,{children:"sudoer"})," would have the ",(0,s.jsx)(n.strong,{children:"configuration"})," set to ",(0,s.jsx)(n.code,{children:"/root/.lightning/config.toml"})," or ",(0,s.jsx)(n.code,{children:"/home/username/.lightning/config.toml"})," depending on using ",(0,s.jsx)(n.strong,{children:"sudo"})," which might cause some confusion to some users."]})})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},4405:(e,n,t)=>{t.d(n,{ZP:()=>r});var s=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["You should be following the ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user-1",children:"create a user"})," recommendation. For our example, we have the username ",(0,s.jsx)(n.code,{children:"lgtn"}),"."]}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["If you have chosen a different username, replace ",(0,s.jsx)(n.code,{children:"lgtn"})," by the correct username you have selected."]})}),"\n",(0,s.jsxs)(n.p,{children:["In the ",(0,s.jsx)(n.code,{children:"config.toml"})," you'll find some and more of the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Find and replace all instances of ",(0,s.jsx)(n.code,{children:"~"})," in the config file ",(0,s.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"}),". Here's an example using ",(0,s.jsx)(n.code,{children:"sed"}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"config.toml"})," example below is a shorter version of what you'll encounter, yours might look different. We do this to keep the guide simple to read. Do not copy and replace with the version demonstrated here."]})}),"\n",(0,s.jsxs)(n.p,{children:["Once changed, all the instances of ",(0,s.jsx)(n.code,{children:"~/"})," should be replaced by your user path e.g. ",(0,s.jsx)(n.code,{children:"/home/lgtn/"}),". For our example, the output would look like the following:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "/home/lgtn/.lightning/data/app_db"\n\n[consensus]\nstore_path = "/home/lgtn/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "/home/lgtn/.lightning/blockstore"\n\n[resolver]\nstore_path = "/home/lgtn/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})})]})}function r(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(i,{...e})}):i(e)}},2382:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>g,contentTitle:()=>h,default:()=>m,frontMatter:()=>c,metadata:()=>d,toc:()=>u});var s=t(5893),o=t(1151),i=t(3872),r=t(4405),l=t(1761),a=t(1586);const c={title:"Update CLI from source code",slug:"update-cli-from-source-code",hide_title:!0,tags:["references","help","update","upgrade","fix"]},h=void 0,d={id:"Lightning CLI/update-cli-from-source-code",title:"Update CLI from source code",description:"Although the step-by-step instructions described here are simple to follow, this process is available as an automated script. To use it execute the following command in your server terminal and follow the instructions:",source:"@site/references/Lightning CLI/update-cli-from-source-code.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/update-cli-from-source-code",permalink:"/references/Lightning CLI/update-cli-from-source-code",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/update-cli-from-source-code.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"update",permalink:"/references/tags/update"},{label:"upgrade",permalink:"/references/tags/upgrade"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Update CLI from source code",slug:"update-cli-from-source-code",hide_title:!0,tags:["references","help","update","upgrade","fix"]},sidebar:"defaultSidebar",previous:{title:"Uninstall Lightning Node",permalink:"/references/Lightning CLI/uninstall-lightning-node"},next:{title:"Service keeps running after shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown"}},g={},u=[{value:"Switch to the installation user",id:"switch-to-the-installation-user",level:2},{value:"Change directory to the source code",id:"change-directory-to-the-source-code",level:2},{value:"Checkout to branch",id:"checkout-to-branch",level:2},{value:"Pull the latest changes",id:"pull-the-latest-changes",level:2},{value:"Build binary from the source",id:"build-binary-from-the-source",level:2},{value:"Update the symlink",id:"update-the-symlink",level:2},{value:"Set user path in config.toml",id:"set-user-path-in-configtoml",level:2},{value:"Update the systemd service unit",id:"update-the-systemd-service-unit",level:2},{value:"Clear the data",id:"clear-the-data",level:2},{value:"Update the config.toml",id:"update-the-configtoml",level:2},{value:"Update the config.toml with user home path",id:"update-the-configtoml-with-user-home-path",level:2},{value:"Restart the service",id:"restart-the-service",level:2},{value:"Health checkup",id:"health-checkup",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.admonition,{type:"tip",children:[(0,s.jsx)(n.p,{children:"Although the step-by-step instructions described here are simple to follow, this process is available as an automated script. To use it execute the following command in your server terminal and follow the instructions:"}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/update | bash\n"})})]}),"\n",(0,s.jsx)(n.h2,{id:"switch-to-the-installation-user",children:"Switch to the installation user"}),"\n",(0,s.jsx)(n.p,{children:"Switch to the username you've used throughout the installation process."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su \n"})}),"\n",(0,s.jsxs)(n.p,{children:["For example, if you used the username ",(0,s.jsx)(n.code,{children:"lgtn"})," it'll look like the following command:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,s.jsx)(n.h2,{id:"change-directory-to-the-source-code",children:"Change directory to the source code"}),"\n",(0,s.jsxs)(n.p,{children:["If you have installed it via the recommended process or instructions, then the default location where the ",(0,s.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"source code"})," is stored is ",(0,s.jsx)(n.code,{children:"~/fleek-network/lightning"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["Notice that we use ",(0,s.jsx)(n.code,{children:"~"}),", which refers to ",(0,s.jsx)(n.code,{children:"$HOME"}),". You must use the username used for the installation process. For example, on ",(0,s.jsx)(n.a,{href:"/docs/node/requirements#server",children:"Ubuntu"})," if you use the username ",(0,s.jsx)(n.code,{children:"lgtn"}),", the pathname for ",(0,s.jsx)(n.code,{children:"$HOME"})," is ",(0,s.jsx)(n.code,{children:"/home/lgtn"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"checkout-to-branch",children:"Checkout to branch"}),"\n",(0,s.jsxs)(n.p,{children:["Make sure that you are checked in to the correct branch. For the current testnet phase that'd be ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),". If you use any other branch name, your node will not function correctly. Use the branch name ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git checkout testnet-alpha-1\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["We try to update our documentation promptly but sometimes are a bit behind on any changes we might make in real-time. If you find any typos, such as the wrong branch name, help us by letting us know! Find us in Fleek Network section of our ",(0,s.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"pull-the-latest-changes",children:"Pull the latest changes"}),"\n",(0,s.jsxs)(n.p,{children:["Before make sure that you stash or clear any changes you may have in the working directory, as otherwise, ",(0,s.jsx)(n.code,{children:"git"})," will let you know about local changes\u2013if you'd like to learn more about it read the ",(0,s.jsx)(n.a,{href:"https://git-scm.com/docs/git-stash",children:"git stash document"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["A quick way to clean is to ",(0,s.jsx)(n.code,{children:"stash"})," the changes, for example:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git stash \n"})}),"\n",(0,s.jsxs)(n.p,{children:["To pull the latest changes use the ",(0,s.jsx)(n.code,{children:"git pull"})," command, as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git pull origin testnet-alpha-1\n"})}),"\n",(0,s.jsx)(n.p,{children:"Alternatively, to have to stash and pull, you can reset the repository to the origin."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"git fetch origin testnet-alpha-1\ngit reset --hard origin/testnet-alpha-1\ngit clean -f\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["We are using the branch named ",(0,s.jsx)(n.code,{children:"testnet-alpha-1"}),", which is specific to the early testnet launch. Change to the correct branch name according to needs. For example, in the future the mainnet version will go on branch name ",(0,s.jsx)(n.code,{children:"main"}),"."]})}),"\n",(0,s.jsx)(n.h2,{id:"build-binary-from-the-source",children:"Build binary from the source"}),"\n",(0,s.jsx)(n.p,{children:"To build the binary from the source code, we execute the cargo build command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,s.jsx)(n.h2,{id:"update-the-symlink",children:"Update the symlink"}),"\n",(0,s.jsx)(n.p,{children:"Start by removing the existing one:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'sudo rm -f "/usr/local/bin/lgtn"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["Create a new symlink that links the new build binary to ",(0,s.jsx)(n.code,{children:"/usr/local/bin/lgtn"}),", as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo ln -s ~/fleek-network/lightning/target/release/lightning-node /usr/local/bin/lgtn\n"})}),"\n",(0,s.jsx)(n.h2,{id:"set-user-path-in-configtoml",children:"Set user path in config.toml"}),"\n",(0,s.jsx)(r.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"update-the-systemd-service-unit",children:"Update the systemd service unit"}),"\n",(0,s.jsxs)(n.p,{children:["Open and edit the ",(0,s.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"})," file."]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Replace ",(0,s.jsx)(n.code,{children:""})," with the username. For example, in the ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"documentation"})," we use the username ",(0,s.jsx)(n.code,{children:"lgtn"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Make sure that the ",(0,s.jsx)(n.code,{children:"ExecStart"})," is set correctly"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml -vv run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,s.jsx)(l.ZP,{}),"\n",(0,s.jsx)(n.p,{children:"When complete make sure the file is saved. Followed by a systemctl daemon reload:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,s.jsx)(n.h2,{id:"clear-the-data",children:"Clear the data"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"rm -rf ~/.lightning/data\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Depending on how you control the system, this might need ",(0,s.jsx)(n.strong,{children:"sudo"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf ~/.lightning/data\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"update-the-configtoml",children:["Update the ",(0,s.jsx)(n.code,{children:"config.toml"})]}),"\n",(0,s.jsxs)(n.p,{children:["Remove the ",(0,s.jsx)(n.code,{children:"~/.lightning/config.toml"}),"."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"rm ~/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Create a new ",(0,s.jsx)(n.code,{children:"config.toml"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"lgtn print-config --default > ~/.lightning/config.toml\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"update-the-configtoml-with-user-home-path",children:["Update the ",(0,s.jsx)(n.code,{children:"config.toml"})," with user home path"]}),"\n",(0,s.jsx)(a.ZP,{}),"\n",(0,s.jsx)(n.h2,{id:"restart-the-service",children:"Restart the service"}),"\n",(0,s.jsxs)(n.p,{children:["Once the cargo build process is completed, you have to restart the service. We're assuming you are using non-root user as ",(0,s.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"recommended"}),", you won't use ",(0,s.jsx)(n.strong,{children:"sudo"})," to start the service. The command will look as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart lightning\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"tip",children:(0,s.jsxs)(n.p,{children:["If you have installed the Fleek Network lightning manually, the ",(0,s.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"installation instructions"})," recommended setting up a systemd service for the Fleek Network process. If you haven't, you're advised to check the instructions provided."]})}),"\n",(0,s.jsx)(n.h2,{id:"health-checkup",children:"Health checkup"}),"\n",(0,s.jsx)(n.p,{children:"Do a quick health check by running:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:'curl -w "\\p" localhost:4230/health\n'})}),"\n",(0,s.jsxs)(n.p,{children:["If successful, you should get the response ",(0,s.jsx)(n.code,{children:"running and staked"}),", as follows:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:"running and staked\n"})}),"\n",(0,s.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var s=t(5893);const o=e=>{let{image:n,name:t,title:o,url:i,communityMember:r=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,s.jsx)("img",{src:n,alt:t})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>r});var s=t(7294);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/445e9e2a.e4a8d31a.js b/assets/js/445e9e2a.f29f39d7.js similarity index 98% rename from assets/js/445e9e2a.e4a8d31a.js rename to assets/js/445e9e2a.f29f39d7.js index 34f61bd99..bae9585ae 100644 --- a/assets/js/445e9e2a.e4a8d31a.js +++ b/assets/js/445e9e2a.f29f39d7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8578],{1478:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var n=s(5893),i=s(1151),o=s(3872);const r={title:"Node secret key does not exist",slug:"node-secret-key-does-not-exist",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},a=void 0,d={id:"Lightning CLI/node-secret-key-does-not-exist",title:"Node secret key does not exist",description:"Node secret key does not exist",source:"@site/references/Lightning CLI/node-secret-key-does-not-exist.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/node-secret-key-does-not-exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/node-secret-key-does-not-exist.md",tags:[{label:"keystore",permalink:"/references/tags/keystore"},{label:"lost keys",permalink:"/references/tags/lost-keys"},{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Node secret key does not exist",slug:"node-secret-key-does-not-exist",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},sidebar:"defaultSidebar",previous:{title:"Backing up the keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore"},next:{title:"Permission denied (os error 13)",permalink:"/references/Lightning CLI/permission-denied-os-error-13"}},l={},c=[{value:"Node secret key does not exist",id:"node-secret-key-does-not-exist",level:2}];function h(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"node-secret-key-does-not-exist",children:"Node secret key does not exist"}),"\n",(0,n.jsx)(t.p,{children:'When watching the Fleek Network Lightning service log output, you find the "Node secret key does not exist" message as follows:'}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-sh",children:"Error: Could not start the node.\n\nCaused by:\n Node Initialization failed: InitializationFailed(Tag as SignerInterface>, Node secret key does not exist. Use the CLI to generate keys.)\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Edit the ",(0,n.jsx)(t.code,{children:"~/.lightning/config.toml"})," to include the full location for the PEM files. For example, let's say that it's located under ",(0,n.jsx)(t.code,{children:"/home/skywalker"})," that'd look like:"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:'[signer]\nconsensus_key_path = "/home/skywalker/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/skywalker/.lightning/keystore/node.pem"\n'})}),"\n",(0,n.jsxs)(t.p,{children:["To learn more about how file permissions and ownership work, you're advised to read the reference document ",(0,n.jsx)(t.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"here"}),"."]}),"\n",(0,n.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,t,s)=>{s.d(t,{Z:()=>i});s(7294);var n=s(5893);const i=e=>{let{image:t,name:s,title:i,url:o,communityMember:r=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:o,target:"_blank",alt:s,children:(0,n.jsx)("img",{src:t,alt:s})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:o,target:"_blank",alt:s,children:s})}),(0,n.jsx)("span",{className:"title",children:i}),(0,n.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>r});var n=s(7294);const i={},o=n.createContext(i);function r(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8578],{1478:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var n=s(5893),i=s(1151),o=s(3872);const r={title:"Node secret key does not exist",slug:"node-secret-key-does-not-exist",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},a=void 0,d={id:"Lightning CLI/node-secret-key-does-not-exist",title:"Node secret key does not exist",description:"Node secret key does not exist",source:"@site/references/Lightning CLI/node-secret-key-does-not-exist.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/node-secret-key-does-not-exist",permalink:"/references/Lightning CLI/node-secret-key-does-not-exist",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/node-secret-key-does-not-exist.md",tags:[{label:"keystore",permalink:"/references/tags/keystore"},{label:"lost keys",permalink:"/references/tags/lost-keys"},{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Node secret key does not exist",slug:"node-secret-key-does-not-exist",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},sidebar:"defaultSidebar",previous:{title:"Backing up the keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore"},next:{title:"Permission denied (os error 13)",permalink:"/references/Lightning CLI/permission-denied-os-error-13"}},l={},c=[{value:"Node secret key does not exist",id:"node-secret-key-does-not-exist",level:2}];function h(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"node-secret-key-does-not-exist",children:"Node secret key does not exist"}),"\n",(0,n.jsx)(t.p,{children:'When watching the Fleek Network Lightning service log output, you find the "Node secret key does not exist" message as follows:'}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-sh",children:"Error: Could not start the node.\n\nCaused by:\n Node Initialization failed: InitializationFailed(Tag as SignerInterface>, Node secret key does not exist. Use the CLI to generate keys.)\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Edit the ",(0,n.jsx)(t.code,{children:"~/.lightning/config.toml"})," to include the full location for the PEM files. For example, let's say that it's located under ",(0,n.jsx)(t.code,{children:"/home/skywalker"})," that'd look like:"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:'[signer]\nconsensus_key_path = "/home/skywalker/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/skywalker/.lightning/keystore/node.pem"\n'})}),"\n",(0,n.jsxs)(t.p,{children:["To learn more about how file permissions and ownership work, you're advised to read the reference document ",(0,n.jsx)(t.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"here"}),"."]}),"\n",(0,n.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,t,s)=>{s.d(t,{Z:()=>i});s(7294);var n=s(5893);const i=e=>{let{image:t,name:s,title:i,url:o,communityMember:r=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:o,target:"_blank",alt:s,children:(0,n.jsx)("img",{src:t,alt:s})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:o,target:"_blank",alt:s,children:s})}),(0,n.jsx)("span",{className:"title",children:i}),(0,n.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>r});var n=s(7294);const i={},o=n.createContext(i);function r(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c9535f7.c64ce4e5.js b/assets/js/4c9535f7.e7e0c96d.js similarity index 99% rename from assets/js/4c9535f7.c64ce4e5.js rename to assets/js/4c9535f7.e7e0c96d.js index 0e22fad4d..9fedb0801 100644 --- a/assets/js/4c9535f7.c64ce4e5.js +++ b/assets/js/4c9535f7.e7e0c96d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[6296],{9237:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>p,frontMatter:()=>c,metadata:()=>l,toc:()=>u});var i=t(5893),r=t(1151),o=t(3872),s=t(3183),a=t(8432);const c={title:"Running a node in Docker",hide_title:!0,slug:"running-a-node-in-docker",image:"./assets/running-a-node-in-docker.png?202311181211",date:new Date("2023-09-18T17:00:00.000Z"),description:"A guide on how to run Fleek Network's node in a Docker container",category:"Tutorial",tags:["guide","docker","container"]},d=void 0,l={id:"Node Operators/running-a-node-in-docker",title:"Running a node in Docker",description:"A guide on how to run Fleek Network's node in a Docker container",source:"@site/guides/Node Operators/running-a-node-in-docker.md",sourceDirName:"Node Operators",slug:"/Node Operators/running-a-node-in-docker",permalink:"/guides/Node Operators/running-a-node-in-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/running-a-node-in-docker.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"docker",permalink:"/guides/tags/docker"},{label:"container",permalink:"/guides/tags/container"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Running a node in Docker",hide_title:!0,slug:"running-a-node-in-docker",image:"./assets/running-a-node-in-docker.png?202311181211",date:"2023-09-18T17:00:00.000Z",description:"A guide on how to run Fleek Network's node in a Docker container",category:"Tutorial",tags:["guide","docker","container"]},sidebar:"defaultSidebar",previous:{title:"Managing the keystore",permalink:"/guides/Node Operators/managing-the-keystore"},next:{title:"Transfering setup ownership",permalink:"/guides/Node Operators/transfering-setup-ownership"}},h={image:t(3451).Z},u=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"For the impatient",id:"for-the-impatient",level:2},{value:"Pull and run image",id:"pull-and-run-image",level:3},{value:"Setup",id:"setup",level:2},{value:"Requirements",id:"requirements",level:3},{value:"Create a user",id:"create-a-user",level:3},{value:"Lightning CLI source code",id:"lightning-cli-source-code",level:3},{value:"Change directory to Lightning source code",id:"change-directory-to-lightning-source-code",level:3},{value:"Install Docker",id:"install-docker",level:3},{value:"Create the Docker image",id:"create-the-docker-image",level:3},{value:"Build the Docker image",id:"build-the-docker-image",level:3},{value:"Docker Container",id:"docker-container",level:2},{value:"Generate keys",id:"generate-keys",level:2},{value:"Run the Docker Container as Systemd Service",id:"run-the-docker-container-as-systemd-service",level:2},{value:"Create the Systemd Service Unit",id:"create-the-systemd-service-unit",level:3},{value:"Viewing logs",id:"viewing-logs",level:2},{value:"Conclusion",id:"conclusion",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Running a node in Docker",src:t(8597).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsxs)(n.p,{children:["Our ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/images/",children:"image"})," provides all the requirements to have Fleek Network running quickly and the following guide will provide you a quick reference to get you started with Docker."]}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, if you need a deep dive into Docker, check the official getting started ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/get-started/",children:"here"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["TL;DR If you have Docker experience then you'll find our ",(0,i.jsx)(n.a,{href:"#for-the-impatient",children:"for the impatient"})," sufficient to get started."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Git"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"for-the-impatient",children:"For the impatient"}),"\n",(0,i.jsxs)(n.p,{children:["Building a Docker image requires some effort and some of our users might find it easier to pull our ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/pkgs/container/lightning",children:"latest image"})," for quick access to Lightning CLI, which doesn't require them to build from source."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The Docker Container image for Lightning is located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/pkgs/container/lightning",children:"https://github.com/fleek-network/lightning/pkgs/container/lightning"}),"."]})}),"\n",(0,i.jsx)(n.h3,{id:"pull-and-run-image",children:"Pull and run image"}),"\n",(0,i.jsx)(n.p,{children:"You can pull and run the Lightning pre-built Docker image from our GitHub and run the Docker container quickly by executing the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it ghcr.io/fleek-network/lightning:latest\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["Keys have to be generated when launching the service. On Docker run, if the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"keystore"})," is not found, the keys are automatically generated and stored in the Docker host's ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory. To learn more about how to manage the keystore, visit the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing keystore"})," section."]})}),"\n",(0,i.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,i.jsxs)(n.p,{children:["The Docker image is tied to a CPU architecture, make sure that you have verified the ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#specs",children:"required"})," specifications to run the container successfully."]})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The command has a list of ports ",(0,i.jsx)(n.code,{children:"-p"})," values that map ports in the container on the Docker host. While we try to keep the information across our documentation in sync with the latest changes or requirements e.g. port number changes, make sure that you check the section ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#ports",children:"ports"})," to find the latest updates."]})}),"\n",(0,i.jsx)(n.h2,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(n.h3,{id:"requirements",children:"Requirements"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide successfully, a good amount of memory and disk space is necessary to run Docker. The main reason for our use-case is that your host machine requires a generous amount of memory and disk space, for the containers."}),"\n",(0,i.jsxs)(n.p,{children:["For this guide, we used a server with the 4vCPU, 32\xa0GB ram memory and 20 GB disk space specifications. Learn more about the recommended specifications ",(0,i.jsx)(n.a,{href:"/docs/node/requirements",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"create-a-user",children:"Create a user"}),"\n",(0,i.jsx)(a.ZP,{}),"\n",(0,i.jsx)(n.h3,{id:"lightning-cli-source-code",children:"Lightning CLI source code"}),"\n",(0,i.jsxs)(n.p,{children:["Start by cloning the repository located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"https://github.com/fleek-network/lightning"}),"."]}),"\n",(0,i.jsx)(s.ZP,{}),"\n",(0,i.jsx)(n.h3,{id:"change-directory-to-lightning-source-code",children:"Change directory to Lightning source code"}),"\n",(0,i.jsxs)(n.p,{children:["If you have cloned the project correctly, you should ",(0,i.jsx)(n.code,{children:"change directory"})," to the project source code directory which by default is ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsxs)(n.p,{children:["At time of writing, this is how the project root looks like (e.g. use the ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Ls",children:"ls"})," to see the list):"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n\u251c\u2500\u2500 CODE_OF_CONDUCT.md\n\u251c\u2500\u2500 CONTRIBUTING.md\n\u251c\u2500\u2500 Cargo.lock\n\u251c\u2500\u2500 Cargo.toml\n\u251c\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 codecov.yml\n\u251c\u2500\u2500 core\n\u251c\u2500\u2500 docs\n\u251c\u2500\u2500 etc\n\u251c\u2500\u2500 lib\n\u251c\u2500\u2500 rust-toolchain\n\u251c\u2500\u2500 rustfmt.toml\n\u251c\u2500\u2500 services\n\u2514\u2500\u2500 target\n"})}),"\n",(0,i.jsx)(n.h3,{id:"install-docker",children:"Install Docker"}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To keep our guide short, we're using Ubuntu Linux. You'll have to make the required tweaks for your preferred Linux Distro. Find the list of support operating systems ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"First, update the existing list of packages:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, install the required packages to let apt use packages over HTTPS:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt install apt-transport-https ca-certificates software-properties-common\n"})}),"\n",(0,i.jsx)(n.p,{children:"Add the GPG key for the official Docker repository to your system:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -\n"})}),"\n",(0,i.jsx)(n.p,{children:"Add the Docker repository to apt sources and update the package database with the Docker packages from the new added repository:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu jammy stable"\n'})}),"\n",(0,i.jsx)(n.p,{children:"Set to install from the Docker repo instead of the default Ubuntu repo:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"apt-cache policy docker-ce\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"docker-ce:\n Installed: (none)\n Candidate: 5:24.0.6-1~ubuntu.22.04~jammy\n Version table:\n 5:24.0.6-1~ubuntu.22.04~jammy 500\n 500 https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages\n 5:24.0.6-1~ubuntu.22.04~jammy 500\n"})}),"\n",(0,i.jsx)(n.p,{children:"Finally, install Docker:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt install docker-ce\n"})}),"\n",(0,i.jsx)(n.p,{children:"Once complete you should be able to run it via the CLI, as such:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"docker -v\n"})}),"\n",(0,i.jsx)(n.p,{children:"Here's the output (versions might differ a bit from the time of writing):"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Docker version 24.0.6, build ed223bc\n"})}),"\n",(0,i.jsx)(n.p,{children:"The following command's output will indicate if Docker's working correctly:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run hello-world\n"})}),"\n",(0,i.jsx)(n.p,{children:"Here's an example of the output you'll find us \"Hello from Docker!\":"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'Hello from Docker!\nThis message shows that your installation appears to be working correctly.\n\nTo generate this message, Docker took the following steps:\n 1. The Docker client contacted the Docker daemon.\n 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.\n (amd64)\n 3. The Docker daemon created a new container from that image which runs the\n executable that produces the output you are currently reading.\n 4. The Docker daemon streamed that output to the Docker client, which sent it\n to your terminal.\n\nTo try something more ambitious, you can run an Ubuntu container with:\n $ docker run -it ubuntu bash\n\nShare images, automate workflows, and more with a free Docker ID:\n https://hub.docker.com/\n\nFor more examples and ideas, visit:\n https://docs.docker.com/get-started/\n'})}),"\n",(0,i.jsx)(n.p,{children:"Run all the commands above in your terminal, to confirm everything's working before proceeding to the next steps."}),"\n",(0,i.jsx)(n.h3,{id:"create-the-docker-image",children:"Create the Docker image"}),"\n",(0,i.jsx)(n.p,{children:"A Docker image is a read-only template with instructions for creating a Docker container, like a template. Docker images also act as a starting point when using Docker."}),"\n",(0,i.jsx)(n.p,{children:'The starting point for our use-case is a Dockerfile, where all those "template instructions" are declared.'}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.a,{href:"https://raw.githubusercontent.com/fleek-network/lightning/main/Dockerfile",children:"Dockerfile"})," should exist in the repository source code, so make sure you have ",(0,i.jsx)(n.a,{href:"#change-directory-to-lightning-source-code",children:"change directory to the lightning source code"})," to find it."]}),"\n",(0,i.jsx)(n.h3,{id:"build-the-docker-image",children:"Build the Docker image"}),"\n",(0,i.jsxs)(n.p,{children:["Build the image named as ",(0,i.jsx)(n.code,{children:"lightning"})," from our Dockerfile:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker build -t lightning -f ./Dockerfile .\n"})}),"\n",(0,i.jsx)(n.p,{children:"The build process takes awhile, and you have to wait for completion."}),"\n",(0,i.jsx)(n.p,{children:"The output should be similar to:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"[+] Building 1.2s (16/16) FINISHED docker:default\n => [internal] load build definition from Dockerfile 0.0s\n => => transferring dockerfile: 990B 0.0s\n => [internal] load .dockerignore 0.0s\n => => transferring context: 2B 0.0s\n => [internal] load metadata for docker.io/library/debian:bullseye-slim 0.6s\n => [internal] load metadata for docker.io/library/rust:latest 0.9s\n => [stage-1 1/3] FROM docker.io/library/debian:bullseye-slim@sha256:3bc5e94a0e8329c102203c3f5f26fd67835f0c81633dd6949de0557867a87fac 0.0s\n => [builder 1/7] FROM docker.io/library/rust:latest@sha256:8a4ca3ca75afbc97bcf5362e9a694fe049d15734fbbaf82b8b7e224616c1254b 0.0s\n => [internal] load build context 0.3s\n => => transferring context: 948.93kB 0.3s\n => CACHED [stage-1 2/3] RUN DEBIAN_FRONTEND=noninteractive apt-get update -yq && DEBIAN_FRONTEND=noninteractive apt-get install -yq libs 0.0s\n => CACHED [builder 2/7] WORKDIR /lightning 0.0s\n => CACHED [builder 3/7] RUN apt-get update 0.0s\n => CACHED [builder 4/7] RUN apt-get install -y build-essential cmake clang pkg-config libssl-dev gcc protobuf-comp 0.0s\n => CACHED [builder 5/7] RUN --mount=type=cache,target=/usr/local/cargo/registry cargo install cargo-strip 0.0s\n => CACHED [builder 6/7] COPY . . 0.0s\n => CACHED [builder 7/7] RUN --mount=type=cache,target=/usr/local/cargo/registry --mount=type=cache,target=/lightning/target cargo buil 0.0s\n => CACHED [stage-1 3/3] COPY --from=builder /lightning/target/release/lightning-node /usr/local/bin/lgtn 0.0s\n => exporting to image 0.0s\n => => exporting layers 0.0s\n => => writing image sha256:e8e5ed19f59c3cc6a9add5bdb578c464904e9789d5f386cc4af81044c062d998 0.0s\n => => naming to docker.io/library/lightning\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The Docker image is only required to be built once and/or, when changes are pulled from the remote repository, or specific versions you might be interested in. Otherwise, you're not required to build it every time to run the node. If you'd like to learn how to update the Lightning CLI, find our references ",(0,i.jsx)(n.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"If you don't update your source code and binary build often, you won't have the latest changes, which should happen frequently to take advantage of all the ongoing development. This is quite important to understand, as it causes confusion to some users. The Lightning application at time of writing does not update automatically."})}),"\n",(0,i.jsx)(n.h2,{id:"docker-container",children:"Docker Container"}),"\n",(0,i.jsxs)(n.p,{children:["A container is what's originated from the image we discussed in the section ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"build the docker image"}),", it is a run-able instance of an image. We can create, start, stop, move, or delete a container using the Docker API or CLI."]}),"\n",(0,i.jsx)(n.p,{children:"Following up, we'll learn how to run the Docker container that includes our Lightning CLI program, built from our Dockerfile."}),"\n",(0,i.jsxs)(n.p,{children:["Once the ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"Docker image"})," is ready, run the container based on the image ",(0,i.jsx)(n.code,{children:"lightning"}),". Effectively running the Fleek Network Lightning node process:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it ghcr.io/fleek-network/lightning:latest\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Notice that the command arguments we pass are for the flag's ",(0,i.jsx)(n.code,{children:"-p"})," port numbers, ",(0,i.jsx)(n.code,{children:"-v"})," to bind mount a location in your host to a container path (useful to persist your configuration files, e.g. keystore), ",(0,i.jsx)(n.code,{children:"--name"})," to make it easier to identify, ",(0,i.jsx)(n.code,{children:"-it"})," to make it interactive (e.g. presents output to the terminal), and the image name we ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"built earlier"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:'The output would look as the following, showing the error message "Node is not whitelisted" (this error message is due to the testnet phase that requires nodes to be whitelisted to run successfully):'}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"thread 'main' panicked at 'Node is not whitelisted. Please join the Fleek Discord to get invited.', core/cli/src/testnet_sync.rs:45:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\n/root/init: line 7: 7 Aborted (core dumped) lgtn run\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Keys have to be generated when launching the service. On Docker run, if the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"keystore"})," is not found, the keys are automatically generated and stored in the Docker host's ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Have in mind that the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"})," is where the keystore location paths are configured, which default value is in the user ",(0,i.jsx)(n.code,{children:"$HOME"})," path. The users who customize or modify the default location, need to apply the required customizations. To learn more about how to manage the keystore, visit the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing keystore"})," section."]})}),"\n",(0,i.jsx)(n.h2,{id:"generate-keys",children:"Generate keys"}),"\n",(0,i.jsxs)(n.p,{children:["Execute the ",(0,i.jsx)(n.code,{children:"keys generate"})," command on the container ",(0,i.jsx)(n.code,{children:"lightning-node"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn keys generate\n"})}),"\n",(0,i.jsxs)(n.p,{children:["We've bound the host path ",(0,i.jsx)(n.code,{children:"~/.lightning"})," into the container ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["You can list the contents of the ",(0,i.jsx)(n.code,{children:"~/.lightning"}),", where you should find the ",(0,i.jsx)(n.code,{children:"config.toml"})," and ",(0,i.jsx)(n.code,{children:"keystore"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n..\nconfig.toml\nkeystore\n"})}),"\n",(0,i.jsxs)(n.p,{children:["You only have to run the ",(0,i.jsx)(n.code,{children:"keys generate"})," once from your host."]}),"\n",(0,i.jsx)(n.p,{children:"Finally, you can start the Fleek Network node by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker start lightning-node\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"lightning-node"})," is the name we provided on first run as described in ",(0,i.jsx)(n.a,{href:"#docker-container",children:"docker container"})," section. If you have set a different name, change accordingly."]})}),"\n",(0,i.jsx)(n.h2,{id:"run-the-docker-container-as-systemd-service",children:"Run the Docker Container as Systemd Service"}),"\n",(0,i.jsxs)(n.p,{children:["In this section we\u2019ll cover how to wrap a Docker Container as a Systemd Service without the need for third party tools or complex commands. Some reasons include, minimizing the dependency on the Docker Daemon as we can move to an ",(0,i.jsx)(n.a,{href:"https://opencontainers.org/",children:"OCI complaint solution"})," other that Docker at anytime, or the fact we recommend Systemd Service Units and Systemctl to control the Service in our ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"Native install"})," that most users are familiar. Our goal is to provide guidance to the widest audience possible, if you have other preferences on managing your service that is more fitting to your needs that's fine."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Docker recommends using their cross-platform built-in restart policy for running a Container as a Service. For that, configure your Docker service to ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/install/linux/linux-postinstall/#configure-docker-to-start-on-boot",children:"start on system boot"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"Systemd was specifically developed to serve the purpose of stopping services, dependency checking and recovery of failed services. You can have your host start, stop, enable, check the status, and generally manage a container as a Systemd Service."}),"\n",(0,i.jsx)(n.h3,{id:"create-the-systemd-service-unit",children:"Create the Systemd Service Unit"}),"\n",(0,i.jsxs)(n.p,{children:["We are going to create the unit configuration file in the /etc/systemd/system/ directory. The Service Unit is going to be named as ",(0,i.jsx)(n.code,{children:"docker-lightning.service"}),". To create the file run the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo touch /etc/systemd/system/docker-lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Open the file in your favorite text editor and populate with the content found here:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\nAfter=docker.service\nRequires=docker.service\n\n[Service]\nRestart=always\nRestartSec=5\nTimeoutStartSec=0\nExecStartPre=-/usr/bin/docker kill lightning-node\nExecStartPre=-/usr/bin/docker rm lightning-node\nExecStartPre=/usr/bin/docker pull ghcr.io/fleek-network/lightning:latest\nExecStart=/usr/bin/docker run -p 4200-4299:4200-4299 -p 4300-4399:4300-4399 --mount type=bind,source=/home/skywalker/.lightning,target=/home/lgtn/.lightning --mount type=bind,source=/var/tmp,target=/var/tmp --name lightning-node ghcr.io/fleek-network/lightning:latest\nExecStop=/usr/bin/docker stop lightning-node\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,i.jsx)(n.p,{children:"Once the file is saved, change the file permissions by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo chmod 644 /etc/systemd/system/docker-lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, reload the Systemctl Daemon:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsx)(n.p,{children:"Enable the service on startup when the system boots:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As a result, we are now able to run our containers as a Systemd service. For this, read the document ",(0,i.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"manage systemd service"})," to find more about how to control the service."]}),"\n",(0,i.jsx)(n.h2,{id:"viewing-logs",children:"Viewing logs"}),"\n",(0,i.jsx)(n.p,{children:"To view the logs of a Docker container in real time, use the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have wrapped the ",(0,i.jsx)(n.a,{href:"#run-the-docker-container-as-systemd-service",children:"docker container as a systemd service"}),", you can use the same commands found when installed natively, such as:"]}),"\n",(0,i.jsx)(n.p,{children:"For standard output:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,i.jsx)(n.p,{children:"Or, the standard error:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Learn more about how to ",(0,i.jsx)(n.a,{href:"/docs/node/analyzing-logs",children:"analyze log messages"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"Containers are a way to have a self-contained environment that includes all necessary dependencies, libraries, software, amongst others required to run an application."}),"\n",(0,i.jsxs)(n.p,{children:["Fleek Network's Lightning is developed with ",(0,i.jsx)(n.a,{href:"https://www.rust-lang.org/",children:"Rust"}),", a general-purpose programming language, that requires several dependencies and libraries to compile the project. Some of these libraries are not installed by default and require some troubleshooting for the end user. ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," provides us with containers, self-containing all the required libraries for the purpose of running Lightning, our application."]}),"\n",(0,i.jsxs)(n.p,{children:["We guided you through the initial installation steps, and how to build a ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," image, which then's used to Docker run a container. Plus, provided lower-level commands, to help you understand other present or advanced use-cases, and also at higher level, offerring simple utility methods."]}),"\n",(0,i.jsxs)(n.p,{children:["While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"})," or by opening a ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network",children:"PR"})," in any of our repositories."]}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on Github"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for all the best updates!"]}),"\n",(0,i.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},8432:(e,n,t)=>{t.d(n,{ZP:()=>s});var i=t(5893),r=t(1151);function o(e){const n={admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["We recommend creating a ",(0,i.jsx)(n.code,{children:"non-root"})," user with administrative privileges. It'll allow us to install any system requirements."]}),"\n",(0,i.jsxs)(n.p,{children:["You can create a new user and add to the ",(0,i.jsx)(n.strong,{children:"sudo"})," group by running:"]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["For our example, we'll be using the name ",(0,i.jsx)(n.code,{children:"lgtn"})," but you can pick whichever you'd like. If you already have a ",(0,i.jsx)(n.strong,{children:"sudoer"})," account, you can skip this step."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo adduser lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["After completing the ",(0,i.jsx)(n.code,{children:"adduser"})," steps, execute the ",(0,i.jsx)(n.code,{children:"usermod"})," to add the ",(0,i.jsx)(n.code,{children:"user"})," to the ",(0,i.jsx)(n.strong,{children:"sudo"})," group, as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo usermod -aG sudo lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Switch to the new ",(0,i.jsx)(n.strong,{children:"user"})," by using the command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,i.jsx)(n.p,{children:"Change the directory to the new user's home, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd /home/lgtn\n"})})]})}function s(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},3183:(e,n,t)=>{t.d(n,{ZP:()=>s});var i=t(5893),r=t(1151);function o(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,i.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,i.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,i.jsxs)(n.li,{children:["Download the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,i.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,i.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function s(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>r});t(7294);var i=t(5893);const r=e=>{let{image:n,name:t,title:r,url:o,communityMember:s=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:r}),(0,i.jsxs)("span",{className:"discord",children:[s?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},3451:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/running-a-node-in-docker-cc0a5b3fda558b4b6dd40022fe5dd09f.png"},8597:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/running-a-node-in-docker-cc0a5b3fda558b4b6dd40022fe5dd09f.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var i=t(7294);const r={},o=i.createContext(r);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[6296],{9237:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>p,frontMatter:()=>c,metadata:()=>l,toc:()=>u});var i=t(5893),r=t(1151),o=t(3872),s=t(3183),a=t(8432);const c={title:"Running a node in Docker",hide_title:!0,slug:"running-a-node-in-docker",image:"./assets/running-a-node-in-docker.png?202311181211",date:new Date("2023-09-18T17:00:00.000Z"),description:"A guide on how to run Fleek Network's node in a Docker container",category:"Tutorial",tags:["guide","docker","container"]},d=void 0,l={id:"Node Operators/running-a-node-in-docker",title:"Running a node in Docker",description:"A guide on how to run Fleek Network's node in a Docker container",source:"@site/guides/Node Operators/running-a-node-in-docker.md",sourceDirName:"Node Operators",slug:"/Node Operators/running-a-node-in-docker",permalink:"/guides/Node Operators/running-a-node-in-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/running-a-node-in-docker.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"docker",permalink:"/guides/tags/docker"},{label:"container",permalink:"/guides/tags/container"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Running a node in Docker",hide_title:!0,slug:"running-a-node-in-docker",image:"./assets/running-a-node-in-docker.png?202311181211",date:"2023-09-18T17:00:00.000Z",description:"A guide on how to run Fleek Network's node in a Docker container",category:"Tutorial",tags:["guide","docker","container"]},sidebar:"defaultSidebar",previous:{title:"Managing the keystore",permalink:"/guides/Node Operators/managing-the-keystore"},next:{title:"Transfering setup ownership",permalink:"/guides/Node Operators/transfering-setup-ownership"}},h={image:t(3451).Z},u=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"For the impatient",id:"for-the-impatient",level:2},{value:"Pull and run image",id:"pull-and-run-image",level:3},{value:"Setup",id:"setup",level:2},{value:"Requirements",id:"requirements",level:3},{value:"Create a user",id:"create-a-user",level:3},{value:"Lightning CLI source code",id:"lightning-cli-source-code",level:3},{value:"Change directory to Lightning source code",id:"change-directory-to-lightning-source-code",level:3},{value:"Install Docker",id:"install-docker",level:3},{value:"Create the Docker image",id:"create-the-docker-image",level:3},{value:"Build the Docker image",id:"build-the-docker-image",level:3},{value:"Docker Container",id:"docker-container",level:2},{value:"Generate keys",id:"generate-keys",level:2},{value:"Run the Docker Container as Systemd Service",id:"run-the-docker-container-as-systemd-service",level:2},{value:"Create the Systemd Service Unit",id:"create-the-systemd-service-unit",level:3},{value:"Viewing logs",id:"viewing-logs",level:2},{value:"Conclusion",id:"conclusion",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Running a node in Docker",src:t(8597).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsxs)(n.p,{children:["Our ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/images/",children:"image"})," provides all the requirements to have Fleek Network running quickly and the following guide will provide you a quick reference to get you started with Docker."]}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, if you need a deep dive into Docker, check the official getting started ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/get-started/",children:"here"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["TL;DR If you have Docker experience then you'll find our ",(0,i.jsx)(n.a,{href:"#for-the-impatient",children:"for the impatient"})," sufficient to get started."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Git"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"for-the-impatient",children:"For the impatient"}),"\n",(0,i.jsxs)(n.p,{children:["Building a Docker image requires some effort and some of our users might find it easier to pull our ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/pkgs/container/lightning",children:"latest image"})," for quick access to Lightning CLI, which doesn't require them to build from source."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The Docker Container image for Lightning is located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/pkgs/container/lightning",children:"https://github.com/fleek-network/lightning/pkgs/container/lightning"}),"."]})}),"\n",(0,i.jsx)(n.h3,{id:"pull-and-run-image",children:"Pull and run image"}),"\n",(0,i.jsx)(n.p,{children:"You can pull and run the Lightning pre-built Docker image from our GitHub and run the Docker container quickly by executing the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it ghcr.io/fleek-network/lightning:latest\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["Keys have to be generated when launching the service. On Docker run, if the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"keystore"})," is not found, the keys are automatically generated and stored in the Docker host's ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory. To learn more about how to manage the keystore, visit the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing keystore"})," section."]})}),"\n",(0,i.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,i.jsxs)(n.p,{children:["The Docker image is tied to a CPU architecture, make sure that you have verified the ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#specs",children:"required"})," specifications to run the container successfully."]})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The command has a list of ports ",(0,i.jsx)(n.code,{children:"-p"})," values that map ports in the container on the Docker host. While we try to keep the information across our documentation in sync with the latest changes or requirements e.g. port number changes, make sure that you check the section ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#ports",children:"ports"})," to find the latest updates."]})}),"\n",(0,i.jsx)(n.h2,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(n.h3,{id:"requirements",children:"Requirements"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide successfully, a good amount of memory and disk space is necessary to run Docker. The main reason for our use-case is that your host machine requires a generous amount of memory and disk space, for the containers."}),"\n",(0,i.jsxs)(n.p,{children:["For this guide, we used a server with the 4vCPU, 32\xa0GB ram memory and 20 GB disk space specifications. Learn more about the recommended specifications ",(0,i.jsx)(n.a,{href:"/docs/node/requirements",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"create-a-user",children:"Create a user"}),"\n",(0,i.jsx)(a.ZP,{}),"\n",(0,i.jsx)(n.h3,{id:"lightning-cli-source-code",children:"Lightning CLI source code"}),"\n",(0,i.jsxs)(n.p,{children:["Start by cloning the repository located at ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"https://github.com/fleek-network/lightning"}),"."]}),"\n",(0,i.jsx)(s.ZP,{}),"\n",(0,i.jsx)(n.h3,{id:"change-directory-to-lightning-source-code",children:"Change directory to Lightning source code"}),"\n",(0,i.jsxs)(n.p,{children:["If you have cloned the project correctly, you should ",(0,i.jsx)(n.code,{children:"change directory"})," to the project source code directory which by default is ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsxs)(n.p,{children:["At time of writing, this is how the project root looks like (e.g. use the ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Ls",children:"ls"})," to see the list):"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n\u251c\u2500\u2500 CODE_OF_CONDUCT.md\n\u251c\u2500\u2500 CONTRIBUTING.md\n\u251c\u2500\u2500 Cargo.lock\n\u251c\u2500\u2500 Cargo.toml\n\u251c\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 codecov.yml\n\u251c\u2500\u2500 core\n\u251c\u2500\u2500 docs\n\u251c\u2500\u2500 etc\n\u251c\u2500\u2500 lib\n\u251c\u2500\u2500 rust-toolchain\n\u251c\u2500\u2500 rustfmt.toml\n\u251c\u2500\u2500 services\n\u2514\u2500\u2500 target\n"})}),"\n",(0,i.jsx)(n.h3,{id:"install-docker",children:"Install Docker"}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To keep our guide short, we're using Ubuntu Linux. You'll have to make the required tweaks for your preferred Linux Distro. Find the list of support operating systems ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"First, update the existing list of packages:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, install the required packages to let apt use packages over HTTPS:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt install apt-transport-https ca-certificates software-properties-common\n"})}),"\n",(0,i.jsx)(n.p,{children:"Add the GPG key for the official Docker repository to your system:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -\n"})}),"\n",(0,i.jsx)(n.p,{children:"Add the Docker repository to apt sources and update the package database with the Docker packages from the new added repository:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu jammy stable"\n'})}),"\n",(0,i.jsx)(n.p,{children:"Set to install from the Docker repo instead of the default Ubuntu repo:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"apt-cache policy docker-ce\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"docker-ce:\n Installed: (none)\n Candidate: 5:24.0.6-1~ubuntu.22.04~jammy\n Version table:\n 5:24.0.6-1~ubuntu.22.04~jammy 500\n 500 https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages\n 5:24.0.6-1~ubuntu.22.04~jammy 500\n"})}),"\n",(0,i.jsx)(n.p,{children:"Finally, install Docker:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo apt install docker-ce\n"})}),"\n",(0,i.jsx)(n.p,{children:"Once complete you should be able to run it via the CLI, as such:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"docker -v\n"})}),"\n",(0,i.jsx)(n.p,{children:"Here's the output (versions might differ a bit from the time of writing):"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Docker version 24.0.6, build ed223bc\n"})}),"\n",(0,i.jsx)(n.p,{children:"The following command's output will indicate if Docker's working correctly:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run hello-world\n"})}),"\n",(0,i.jsx)(n.p,{children:"Here's an example of the output you'll find us \"Hello from Docker!\":"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'Hello from Docker!\nThis message shows that your installation appears to be working correctly.\n\nTo generate this message, Docker took the following steps:\n 1. The Docker client contacted the Docker daemon.\n 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.\n (amd64)\n 3. The Docker daemon created a new container from that image which runs the\n executable that produces the output you are currently reading.\n 4. The Docker daemon streamed that output to the Docker client, which sent it\n to your terminal.\n\nTo try something more ambitious, you can run an Ubuntu container with:\n $ docker run -it ubuntu bash\n\nShare images, automate workflows, and more with a free Docker ID:\n https://hub.docker.com/\n\nFor more examples and ideas, visit:\n https://docs.docker.com/get-started/\n'})}),"\n",(0,i.jsx)(n.p,{children:"Run all the commands above in your terminal, to confirm everything's working before proceeding to the next steps."}),"\n",(0,i.jsx)(n.h3,{id:"create-the-docker-image",children:"Create the Docker image"}),"\n",(0,i.jsx)(n.p,{children:"A Docker image is a read-only template with instructions for creating a Docker container, like a template. Docker images also act as a starting point when using Docker."}),"\n",(0,i.jsx)(n.p,{children:'The starting point for our use-case is a Dockerfile, where all those "template instructions" are declared.'}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.a,{href:"https://raw.githubusercontent.com/fleek-network/lightning/main/Dockerfile",children:"Dockerfile"})," should exist in the repository source code, so make sure you have ",(0,i.jsx)(n.a,{href:"#change-directory-to-lightning-source-code",children:"change directory to the lightning source code"})," to find it."]}),"\n",(0,i.jsx)(n.h3,{id:"build-the-docker-image",children:"Build the Docker image"}),"\n",(0,i.jsxs)(n.p,{children:["Build the image named as ",(0,i.jsx)(n.code,{children:"lightning"})," from our Dockerfile:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker build -t lightning -f ./Dockerfile .\n"})}),"\n",(0,i.jsx)(n.p,{children:"The build process takes awhile, and you have to wait for completion."}),"\n",(0,i.jsx)(n.p,{children:"The output should be similar to:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"[+] Building 1.2s (16/16) FINISHED docker:default\n => [internal] load build definition from Dockerfile 0.0s\n => => transferring dockerfile: 990B 0.0s\n => [internal] load .dockerignore 0.0s\n => => transferring context: 2B 0.0s\n => [internal] load metadata for docker.io/library/debian:bullseye-slim 0.6s\n => [internal] load metadata for docker.io/library/rust:latest 0.9s\n => [stage-1 1/3] FROM docker.io/library/debian:bullseye-slim@sha256:3bc5e94a0e8329c102203c3f5f26fd67835f0c81633dd6949de0557867a87fac 0.0s\n => [builder 1/7] FROM docker.io/library/rust:latest@sha256:8a4ca3ca75afbc97bcf5362e9a694fe049d15734fbbaf82b8b7e224616c1254b 0.0s\n => [internal] load build context 0.3s\n => => transferring context: 948.93kB 0.3s\n => CACHED [stage-1 2/3] RUN DEBIAN_FRONTEND=noninteractive apt-get update -yq && DEBIAN_FRONTEND=noninteractive apt-get install -yq libs 0.0s\n => CACHED [builder 2/7] WORKDIR /lightning 0.0s\n => CACHED [builder 3/7] RUN apt-get update 0.0s\n => CACHED [builder 4/7] RUN apt-get install -y build-essential cmake clang pkg-config libssl-dev gcc protobuf-comp 0.0s\n => CACHED [builder 5/7] RUN --mount=type=cache,target=/usr/local/cargo/registry cargo install cargo-strip 0.0s\n => CACHED [builder 6/7] COPY . . 0.0s\n => CACHED [builder 7/7] RUN --mount=type=cache,target=/usr/local/cargo/registry --mount=type=cache,target=/lightning/target cargo buil 0.0s\n => CACHED [stage-1 3/3] COPY --from=builder /lightning/target/release/lightning-node /usr/local/bin/lgtn 0.0s\n => exporting to image 0.0s\n => => exporting layers 0.0s\n => => writing image sha256:e8e5ed19f59c3cc6a9add5bdb578c464904e9789d5f386cc4af81044c062d998 0.0s\n => => naming to docker.io/library/lightning\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The Docker image is only required to be built once and/or, when changes are pulled from the remote repository, or specific versions you might be interested in. Otherwise, you're not required to build it every time to run the node. If you'd like to learn how to update the Lightning CLI, find our references ",(0,i.jsx)(n.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code",children:"here"}),"."]})}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"If you don't update your source code and binary build often, you won't have the latest changes, which should happen frequently to take advantage of all the ongoing development. This is quite important to understand, as it causes confusion to some users. The Lightning application at time of writing does not update automatically."})}),"\n",(0,i.jsx)(n.h2,{id:"docker-container",children:"Docker Container"}),"\n",(0,i.jsxs)(n.p,{children:["A container is what's originated from the image we discussed in the section ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"build the docker image"}),", it is a run-able instance of an image. We can create, start, stop, move, or delete a container using the Docker API or CLI."]}),"\n",(0,i.jsx)(n.p,{children:"Following up, we'll learn how to run the Docker container that includes our Lightning CLI program, built from our Dockerfile."}),"\n",(0,i.jsxs)(n.p,{children:["Once the ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"Docker image"})," is ready, run the container based on the image ",(0,i.jsx)(n.code,{children:"lightning"}),". Effectively running the Fleek Network Lightning node process:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it ghcr.io/fleek-network/lightning:latest\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Notice that the command arguments we pass are for the flag's ",(0,i.jsx)(n.code,{children:"-p"})," port numbers, ",(0,i.jsx)(n.code,{children:"-v"})," to bind mount a location in your host to a container path (useful to persist your configuration files, e.g. keystore), ",(0,i.jsx)(n.code,{children:"--name"})," to make it easier to identify, ",(0,i.jsx)(n.code,{children:"-it"})," to make it interactive (e.g. presents output to the terminal), and the image name we ",(0,i.jsx)(n.a,{href:"#build-the-docker-image",children:"built earlier"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:'The output would look as the following, showing the error message "Node is not whitelisted" (this error message is due to the testnet phase that requires nodes to be whitelisted to run successfully):'}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"thread 'main' panicked at 'Node is not whitelisted. Please join the Fleek Discord to get invited.', core/cli/src/testnet_sync.rs:45:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\n/root/init: line 7: 7 Aborted (core dumped) lgtn run\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Keys have to be generated when launching the service. On Docker run, if the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"keystore"})," is not found, the keys are automatically generated and stored in the Docker host's ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Have in mind that the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"})," is where the keystore location paths are configured, which default value is in the user ",(0,i.jsx)(n.code,{children:"$HOME"})," path. The users who customize or modify the default location, need to apply the required customizations. To learn more about how to manage the keystore, visit the ",(0,i.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing keystore"})," section."]})}),"\n",(0,i.jsx)(n.h2,{id:"generate-keys",children:"Generate keys"}),"\n",(0,i.jsxs)(n.p,{children:["Execute the ",(0,i.jsx)(n.code,{children:"keys generate"})," command on the container ",(0,i.jsx)(n.code,{children:"lightning-node"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn keys generate\n"})}),"\n",(0,i.jsxs)(n.p,{children:["We've bound the host path ",(0,i.jsx)(n.code,{children:"~/.lightning"})," into the container ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["You can list the contents of the ",(0,i.jsx)(n.code,{children:"~/.lightning"}),", where you should find the ",(0,i.jsx)(n.code,{children:"config.toml"})," and ",(0,i.jsx)(n.code,{children:"keystore"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n..\nconfig.toml\nkeystore\n"})}),"\n",(0,i.jsxs)(n.p,{children:["You only have to run the ",(0,i.jsx)(n.code,{children:"keys generate"})," once from your host."]}),"\n",(0,i.jsx)(n.p,{children:"Finally, you can start the Fleek Network node by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker start lightning-node\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"lightning-node"})," is the name we provided on first run as described in ",(0,i.jsx)(n.a,{href:"#docker-container",children:"docker container"})," section. If you have set a different name, change accordingly."]})}),"\n",(0,i.jsx)(n.h2,{id:"run-the-docker-container-as-systemd-service",children:"Run the Docker Container as Systemd Service"}),"\n",(0,i.jsxs)(n.p,{children:["In this section we\u2019ll cover how to wrap a Docker Container as a Systemd Service without the need for third party tools or complex commands. Some reasons include, minimizing the dependency on the Docker Daemon as we can move to an ",(0,i.jsx)(n.a,{href:"https://opencontainers.org/",children:"OCI complaint solution"})," other that Docker at anytime, or the fact we recommend Systemd Service Units and Systemctl to control the Service in our ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"Native install"})," that most users are familiar. Our goal is to provide guidance to the widest audience possible, if you have other preferences on managing your service that is more fitting to your needs that's fine."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Docker recommends using their cross-platform built-in restart policy for running a Container as a Service. For that, configure your Docker service to ",(0,i.jsx)(n.a,{href:"https://docs.docker.com/install/linux/linux-postinstall/#configure-docker-to-start-on-boot",children:"start on system boot"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"Systemd was specifically developed to serve the purpose of stopping services, dependency checking and recovery of failed services. You can have your host start, stop, enable, check the status, and generally manage a container as a Systemd Service."}),"\n",(0,i.jsx)(n.h3,{id:"create-the-systemd-service-unit",children:"Create the Systemd Service Unit"}),"\n",(0,i.jsxs)(n.p,{children:["We are going to create the unit configuration file in the /etc/systemd/system/ directory. The Service Unit is going to be named as ",(0,i.jsx)(n.code,{children:"docker-lightning.service"}),". To create the file run the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo touch /etc/systemd/system/docker-lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Open the file in your favorite text editor and populate with the content found here:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\nAfter=docker.service\nRequires=docker.service\n\n[Service]\nRestart=always\nRestartSec=5\nTimeoutStartSec=0\nExecStartPre=-/usr/bin/docker kill lightning-node\nExecStartPre=-/usr/bin/docker rm lightning-node\nExecStartPre=/usr/bin/docker pull ghcr.io/fleek-network/lightning:latest\nExecStart=/usr/bin/docker run -p 4200-4299:4200-4299 -p 4300-4399:4300-4399 --mount type=bind,source=/home/skywalker/.lightning,target=/home/lgtn/.lightning --mount type=bind,source=/var/tmp,target=/var/tmp --name lightning-node ghcr.io/fleek-network/lightning:latest\nExecStop=/usr/bin/docker stop lightning-node\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,i.jsx)(n.p,{children:"Once the file is saved, change the file permissions by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo chmod 644 /etc/systemd/system/docker-lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, reload the Systemctl Daemon:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsx)(n.p,{children:"Enable the service on startup when the system boots:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["As a result, we are now able to run our containers as a Systemd service. For this, read the document ",(0,i.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"manage systemd service"})," to find more about how to control the service."]}),"\n",(0,i.jsx)(n.h2,{id:"viewing-logs",children:"Viewing logs"}),"\n",(0,i.jsx)(n.p,{children:"To view the logs of a Docker container in real time, use the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have wrapped the ",(0,i.jsx)(n.a,{href:"#run-the-docker-container-as-systemd-service",children:"docker container as a systemd service"}),", you can use the same commands found when installed natively, such as:"]}),"\n",(0,i.jsx)(n.p,{children:"For standard output:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,i.jsx)(n.p,{children:"Or, the standard error:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Learn more about how to ",(0,i.jsx)(n.a,{href:"/docs/node/analyzing-logs",children:"analyze log messages"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"Containers are a way to have a self-contained environment that includes all necessary dependencies, libraries, software, amongst others required to run an application."}),"\n",(0,i.jsxs)(n.p,{children:["Fleek Network's Lightning is developed with ",(0,i.jsx)(n.a,{href:"https://www.rust-lang.org/",children:"Rust"}),", a general-purpose programming language, that requires several dependencies and libraries to compile the project. Some of these libraries are not installed by default and require some troubleshooting for the end user. ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," provides us with containers, self-containing all the required libraries for the purpose of running Lightning, our application."]}),"\n",(0,i.jsxs)(n.p,{children:["We guided you through the initial installation steps, and how to build a ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," image, which then's used to Docker run a container. Plus, provided lower-level commands, to help you understand other present or advanced use-cases, and also at higher level, offerring simple utility methods."]}),"\n",(0,i.jsxs)(n.p,{children:["While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"})," or by opening a ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network",children:"PR"})," in any of our repositories."]}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on Github"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for all the best updates!"]}),"\n",(0,i.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},8432:(e,n,t)=>{t.d(n,{ZP:()=>s});var i=t(5893),r=t(1151);function o(e){const n={admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["We recommend creating a ",(0,i.jsx)(n.code,{children:"non-root"})," user with administrative privileges. It'll allow us to install any system requirements."]}),"\n",(0,i.jsxs)(n.p,{children:["You can create a new user and add to the ",(0,i.jsx)(n.strong,{children:"sudo"})," group by running:"]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["For our example, we'll be using the name ",(0,i.jsx)(n.code,{children:"lgtn"})," but you can pick whichever you'd like. If you already have a ",(0,i.jsx)(n.strong,{children:"sudoer"})," account, you can skip this step."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo adduser lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["After completing the ",(0,i.jsx)(n.code,{children:"adduser"})," steps, execute the ",(0,i.jsx)(n.code,{children:"usermod"})," to add the ",(0,i.jsx)(n.code,{children:"user"})," to the ",(0,i.jsx)(n.strong,{children:"sudo"})," group, as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo usermod -aG sudo lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Switch to the new ",(0,i.jsx)(n.strong,{children:"user"})," by using the command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,i.jsx)(n.p,{children:"Change the directory to the new user's home, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd /home/lgtn\n"})})]})}function s(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},3183:(e,n,t)=>{t.d(n,{ZP:()=>s});var i=t(5893),r=t(1151);function o(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,i.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,i.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,i.jsxs)(n.li,{children:["Download the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,i.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,i.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,i.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function s(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>r});t(7294);var i=t(5893);const r=e=>{let{image:n,name:t,title:r,url:o,communityMember:s=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:r}),(0,i.jsxs)("span",{className:"discord",children:[s?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},3451:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/running-a-node-in-docker-cc0a5b3fda558b4b6dd40022fe5dd09f.png"},8597:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/running-a-node-in-docker-cc0a5b3fda558b4b6dd40022fe5dd09f.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var i=t(7294);const r={},o=i.createContext(r);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4d7007b2.0c4a09fe.js b/assets/js/4d7007b2.d4e0db29.js similarity index 97% rename from assets/js/4d7007b2.0c4a09fe.js rename to assets/js/4d7007b2.d4e0db29.js index b0e4e238a..cfcc09f95 100644 --- a/assets/js/4d7007b2.0c4a09fe.js +++ b/assets/js/4d7007b2.d4e0db29.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[6272],{2482:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=n(5893),s=n(1151);const o=n.p+"assets/images/banner-references-a0368a847f1d60e338779105f44a9e9a.png",i={title:"About references",hide_title:!0,sidebar_position:1,tags:["References","Help"]},a=void 0,c={id:"index",title:"About references",description:"The references provide concise instructions to interface with the system, broken down into commands or small pieces for quick reference.",source:"@site/references/index.md",sourceDirName:".",slug:"/",permalink:"/references/",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/index.md",tags:[{label:"References",permalink:"/references/tags/references"},{label:"Help",permalink:"/references/tags/help"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",sidebarPosition:1,frontMatter:{title:"About references",hide_title:!0,sidebar_position:1,tags:["References","Help"]},sidebar:"defaultSidebar",next:{title:"Build and run in Docker",permalink:"/references/Docker/build-and-run-in-docker"}},d={},l=[];function f(e){const t={a:"a",p:"p",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("img",{className:"banner",src:o}),"\n",(0,r.jsx)(t.p,{children:"The references provide concise instructions to interface with the system, broken down into commands or small pieces for quick reference."}),"\n",(0,r.jsxs)(t.p,{children:["It differs from ",(0,r.jsx)(t.a,{href:"/guides",children:"Guides"})," which is more descriptive or verbose when providing instructions and how-to's."]}),"\n",(0,r.jsx)(t.p,{children:"To start, find references by consulting the available categories to locate the appropriate content on the sidebar. Our references are also available as a result when using the search feature located at the very top of the documentation site."})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(7294);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[6272],{2482:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=n(5893),s=n(1151);const o=n.p+"assets/images/banner-references-a0368a847f1d60e338779105f44a9e9a.png",i={title:"About references",hide_title:!0,sidebar_position:1,tags:["References","Help"]},a=void 0,c={id:"index",title:"About references",description:"The references provide concise instructions to interface with the system, broken down into commands or small pieces for quick reference.",source:"@site/references/index.md",sourceDirName:".",slug:"/",permalink:"/references/",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/index.md",tags:[{label:"References",permalink:"/references/tags/references"},{label:"Help",permalink:"/references/tags/help"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",sidebarPosition:1,frontMatter:{title:"About references",hide_title:!0,sidebar_position:1,tags:["References","Help"]},sidebar:"defaultSidebar",next:{title:"Build and run in Docker",permalink:"/references/Docker/build-and-run-in-docker"}},d={},l=[];function f(e){const t={a:"a",p:"p",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("img",{className:"banner",src:o}),"\n",(0,r.jsx)(t.p,{children:"The references provide concise instructions to interface with the system, broken down into commands or small pieces for quick reference."}),"\n",(0,r.jsxs)(t.p,{children:["It differs from ",(0,r.jsx)(t.a,{href:"/guides",children:"Guides"})," which is more descriptive or verbose when providing instructions and how-to's."]}),"\n",(0,r.jsx)(t.p,{children:"To start, find references by consulting the available categories to locate the appropriate content on the sidebar. Our references are also available as a result when using the search feature located at the very top of the documentation site."})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(f,{...e})}):f(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(7294);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5437f376.f15b7afc.js b/assets/js/5437f376.1e096079.js similarity index 99% rename from assets/js/5437f376.f15b7afc.js rename to assets/js/5437f376.1e096079.js index d806308f5..676110216 100644 --- a/assets/js/5437f376.f15b7afc.js +++ b/assets/js/5437f376.1e096079.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[909],{3616:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>h,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var i=t(5893),s=t(1151),r=t(3872),o=t(5979);const a={title:"Managing the keystore",hide_title:!0,slug:"managing-the-keystore",date:new Date("2023-11-14T12:00:00.000Z"),image:"./assets/managing-the-keystore.png?202311181211",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",category:"Tutorial",tags:["guide","keystore","public keys","private keys","keys"]},h=void 0,l={id:"Node Operators/managing-the-keystore",title:"Managing the keystore",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",source:"@site/guides/Node Operators/managing-the-keystore.md",sourceDirName:"Node Operators",slug:"/Node Operators/managing-the-keystore",permalink:"/guides/Node Operators/managing-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/managing-the-keystore.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"keystore",permalink:"/guides/tags/keystore"},{label:"public keys",permalink:"/guides/tags/public-keys"},{label:"private keys",permalink:"/guides/tags/private-keys"},{label:"keys",permalink:"/guides/tags/keys"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Managing the keystore",hide_title:!0,slug:"managing-the-keystore",date:"2023-11-14T12:00:00.000Z",image:"./assets/managing-the-keystore.png?202311181211",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",category:"Tutorial",tags:["guide","keystore","public keys","private keys","keys"]},sidebar:"defaultSidebar",previous:{title:"How to manage log files",permalink:"/guides/Node Operators/how-to-manage-log-files"},next:{title:"Running a node in Docker",permalink:"/guides/Node Operators/running-a-node-in-docker"}},d={image:t(4110).Z},c=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Configuration file",id:"configuration-file",level:2},{value:"Locating the file",id:"locating-the-file",level:3},{value:"Configuration sections",id:"configuration-sections",level:3},{value:"Type of keys",id:"type-of-keys",level:3},{value:"Key privacy",id:"key-privacy",level:3},{value:"Identity selection",id:"identity-selection",level:3},{value:"Backing up the keystore",id:"backing-up-the-keystore",level:2},{value:"Lower security",id:"lower-security",level:3},{value:"Higher security",id:"higher-security",level:3},{value:"Storage",id:"storage",level:3},{value:"Loading keys on runtime",id:"loading-keys-on-runtime",level:2},{value:"Restoring the keystore",id:"restoring-the-keystore",level:2},{value:"Conclusion",id:"conclusion",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Managing the keystore",src:t(4350).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network incentivizes participation by rewarding its node providers. A node is identifiable by an identity, which the reward mechanism uses to identify the node to reward it."}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsxs)(n.p,{children:["At time of writing the rewards mechanism hasn't yet been introduced, read the ",(0,i.jsx)(n.a,{href:"https://blog.fleek.network/post/fleek-network-testnet-plans",children:"testnet plans"})," to get a high level perspective over the plans. A token and economics paper should be released in the future."]})}),"\n",(0,i.jsxs)(n.p,{children:["We'll use the term identity to describe the key store declared in the configuration, in our case ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail",children:"PEM"})," files. The content of the PEM files and the file itself should be kept secret."]}),"\n",(0,i.jsxs)(n.p,{children:["The key store is in the file system and the location is defined in the Fleek Network ",(0,i.jsx)(n.code,{children:"~/.lightning/config.toml"}),", as a private key stored in an identity named PEM file (by default ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"}),"). It's essential to understand this, as you may want to copy the identity to a new server setup, to persist the identity accross to the new server setup."]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"Security is achieved by issuing users private cryptographic keys. Only the holder of the private key has access to sensitive information, such as an identity, which relates to reputation, rewards, etc. The security of the private key is the responsibility of the user. Unfortunately, Fleek Network is unable to help you regain access to your private key if you've lost or failed to secure it. The private keys are your responsibility."})}),"\n",(0,i.jsxs)(n.p,{children:["The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"supported system"})," you're migrating to."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsxs)(n.li,{children:["A basic understanding of ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Public-key_cryptography",children:"how public key cryptography works"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"configuration-file",children:"Configuration file"}),"\n",(0,i.jsx)(n.h3,{id:"locating-the-file",children:"Locating the file"}),"\n",(0,i.jsxs)(n.p,{children:["The Lightning CLI has a configuration file in the home directory of the user, which by default is located in the path ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"})," or ",(0,i.jsx)(n.code,{children:"~/.lightning"})," under the name ",(0,i.jsx)(n.code,{children:"config.toml"}),". It's generally described as ",(0,i.jsx)(n.code,{children:"~/.lightning/config.toml"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The tilde in ",(0,i.jsx)(n.code,{children:"~/.lightning"})," represents ",(0,i.jsx)(n.code,{children:"$HOME"})," which is simpler, but we'll use ",(0,i.jsx)(n.code,{children:"$HOME"})," to make it easy to follow."]})}),"\n",(0,i.jsxs)(n.p,{children:["If you're following the install recommendations you should be logged in with a ",(0,i.jsx)(n.strong,{children:"sudoer"})," account. For our guide, let's imagine that the ",(0,i.jsx)(n.strong,{children:"sudoer"})," username we are logged in with is ",(0,i.jsx)(n.strong,{children:"lgtn"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The word ",(0,i.jsx)(n.strong,{children:"sudo"}),' is the abbreviation of the term "super user do". As the name suggests, it is the privilege that a super user, such as an administrator has to do whatever it wants in the system. A super user can be an administrator, like the ',(0,i.jsx)(n.strong,{children:"root"})," or what we described here as a user in the group ",(0,i.jsx)(n.strong,{children:"sudo"})," aka ",(0,i.jsx)(n.strong,{children:"sudoer"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"If you are logged in with a username, that'd be:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home//.lightning/config.toml\n"})}),"\n",(0,i.jsxs)(n.p,{children:["For our example for user ",(0,i.jsx)(n.code,{children:"lgtn"})," that is:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home/lgtn/.lightning/config.toml\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you log in with another user, let's say ",(0,i.jsx)(n.code,{children:"fleek"})," it'd be:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home/fleek/.lightning/config.toml\n"})}),"\n",(0,i.jsx)(n.p,{children:"At any time, you can check which user you are logged in with by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of our user ",(0,i.jsx)(n.code,{children:"lgtn"}),", which for the command above outputs:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To switch to a particular user, you can run the command ",(0,i.jsx)(n.code,{children:"su "})," e.g. for the user ",(0,i.jsx)(n.strong,{children:"lgtn"})," we would execute the command ",(0,i.jsx)(n.code,{children:"su lgtn"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["Now that you know where to locate the configuration file for any given user you are logged in with, learn about the ",(0,i.jsx)(n.a,{href:"#configuration-sections",children:"Configuration sections"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"configuration-sections",children:"Configuration sections"}),"\n",(0,i.jsxs)(n.p,{children:["The Fleek Network node configuration settings are located in the path ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),", and it's organized by configuration sections."]}),"\n",(0,i.jsx)(n.p,{children:"At the time of writing, we have a TOML file with sections. Here are some examples amongst others:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"application"}),"\n",(0,i.jsx)(n.li,{children:"origin-ipfs"}),"\n",(0,i.jsx)(n.li,{children:"rpc"}),"\n",(0,i.jsx)(n.li,{children:"signer"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Each of the sections holds several property names and values. If you are accustomed to the ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/JSON",children:"JSON"})," or ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/YAML",children:"YAML"})," formats, you'll find the TOML format a bit similar (if you'd like to learn more about the TOML file format, read about it ",(0,i.jsx)(n.a,{href:"https://toml.io/en/",children:"here"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"By default, and at time of writing the Lightning CLI configuration file (config.toml) is similar to:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'[BLANK]\n\n[application]\ndb_path = "/home/lgtn/.lightning/data/app_db"\nmode = "Prod"\nstorage = "RocksDb"\ntestnet = true\n\n[blockserver]\naddress = "0.0.0.0:4211"\n\n[broadcast]\naddress = "0.0.0.0:4200"\n\n[consensus]\nstore_path = "/home/lgtn/.lightning/data/narwhal_store"\n\n[dht]\naddress = "0.0.0.0:8101"\nbootstrappers = []\n\n[fetcher]\n\n[fsstore]\nroot = "/home/lgtn/.lightning/blockstore"\n\n[[handshake.transport]]\nsignal_address = "0.0.0.0:4210"\ntype = "WebRTC"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[origin-ipfs.gateways]]\nauthority = "ipfs.io"\nprotocol = "Https"\n\n[[origin-ipfs.gateways]]\nauthority = "fleek.ipfs.io"\nprotocol = "Https"\n\n[[origin-ipfs.gateways]]\nauthority = "ipfs.runfission.com"\nprotocol = "Https"\n\n[rep-collector]\nreporter_buffer_size = 5\n\n[resolver]\nstore_path = "/home/lgtn/.lightning/data/resolver_store"\n\n[rpc]\naddr = "0.0.0.0"\nport = 4230\n\n[service-executor]\nservices = [0, 1]\n\n[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n\n[topology]\ntesting_min_nodes = 9\ntesting_target_k = 8\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"Beware that the configuration file might look a bit different depending on the version you're running and the current development features in place by the Fleek Network core team. You shouldn't copy the example above and replace with yours, as this only servers for illustrative purposes."})}),"\n",(0,i.jsx)(n.p,{children:"Some advanced use cases might require dealing with the host and port number binding, depending on the service provider's needs and customization. We'll keep things simple and assume the default settings."}),"\n",(0,i.jsxs)(n.p,{children:["In this guide, we are interested in the ",(0,i.jsx)(n.code,{children:"[signer]"})," section settings for the ",(0,i.jsx)(n.code,{children:"consensus_key_path"})," and ",(0,i.jsx)(n.code,{children:"node_key_path"})," which by default is set to ",(0,i.jsx)(n.code,{children:"~/.lightning/keystore"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The identity is a text description for the Keystore and at the time of writing we have not yet implemented multiple identity management via the CLI. Thereupon, the identity value serves to find the filename match in the ",(0,i.jsx)(n.code,{children:"keystore_path"}),". This might change as we progress with development. Check the ",(0,i.jsx)(n.a,{href:"#identity-selection",children:"Identity selection"})," to learn more about it!"]})}),"\n",(0,i.jsx)(n.h3,{id:"type-of-keys",children:"Type of keys"}),"\n",(0,i.jsxs)(n.p,{children:["There are three types of keys related to the identity of a node and the account ownership. The keys are based in public-key cryptography, or asymmetric cryptography where each key pair consists of a public key and a corresponding private key. The keys are described in the section ",(0,i.jsx)(n.a,{href:"/docs/learn/the-network/#identity-on-the-fleek-network",children:"identity on the Fleek Network"})," as follows:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["A Node key (ConsensusPublicKey) is ",(0,i.jsx)(n.a,{href:"https://electriccoin.co/blog/new-snark-curve/",children:"BLS12-381"})," which facilitates the consensus algorithm or persistence of state, resilience and fault tolerance. Has multi-signature support, the ability to aggregate many signatures into one used for consensus committee when signing certificates"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["A Node Networking key (NodePublicKey) is ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/EdDSA",children:"Ed25519"})," used for the speed and performance of the network communications"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Account Owner keys are based on ",(0,i.jsx)(n.a,{href:"https://www.secg.org/sec2-v2.pdf",children:"secp256k1"}),", which corresponds to an Ethereum Address"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"For instance, a public key is open to anybody to see, and it represents a unique node identifier in the Fleek Network, a bit like a passport number. On the other hand, the private key is secret, and the operator is responsible to store it privately."}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network relies on cryptography, thus the Fleek Network team and anybody can access, compromise or manipulate the secrets of an identity. On the other hand, the public key can be used by anyone, Fleek Network included, to identify a node or send rewards to the address without jeopardizing identity security."}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about the identities on the Fleek Network ",(0,i.jsx)(n.a,{href:"/docs/learn/the-network/#identity-on-the-fleek-network",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"key-privacy",children:"Key privacy"}),"\n",(0,i.jsx)(n.p,{children:"If you don\u2019t keep your private keys secret, you'll have your node compromised."}),"\n",(0,i.jsx)(n.p,{children:"Here are a few examples of what you should not do:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Share the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory file content publicly"]}),"\n",(0,i.jsxs)(n.li,{children:["Track the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory files in a version control repository e.g. git"]}),"\n",(0,i.jsxs)(n.li,{children:['Have poor "rights" permissions in UNIX systems e.g. everyone can read, delete, modify ',(0,i.jsx)(n.code,{children:"$HOME/.lightning"})]}),"\n",(0,i.jsx)(n.li,{children:"Allow anyone to access the node provider physically without any access control to the operating and file systems e.g. a VPS provider"}),"\n",(0,i.jsxs)(n.li,{children:["Get rid of a hard drive unformatted or blind erased by selling to somebody or dumping in the bin, which contains ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"There are many other ways of getting compromised, but hopefully, the ones put above give you a good starter into the subject."}),"\n",(0,i.jsx)(n.p,{children:"Remember, the node provider is the only one responsible when managing the key store. Neither Fleek Network nor the most sophisticated AI system presently can compromise the cryptography in use to help you out. You are fully responsible for securing and retaining your private keys."}),"\n",(0,i.jsx)(n.h3,{id:"identity-selection",children:"Identity selection"}),"\n",(0,i.jsx)(n.p,{children:"Multiple identity management is yet to be implemented but in any case, some users might find it trivial to keep multiple identities and switch between them referencing them by name. The following section is not advocating this approach but sharing some approaches that can help certain use-cases."}),"\n",(0,i.jsxs)(n.p,{children:["Let's suppose that we've recently moved to a new server setup and copied our previous server keystore keys as ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"})," and renamed the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore/*.pem"})," to ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore/new-*.pem"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["We are using a wildcard ",(0,i.jsx)(n.code,{children:"*"})," to reduce verbosity. The wildcard means as replacement for all the filenames encountered in the path and extension without having to name them individually as we know they are ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["To illustrate this scenario, here's an example of how our ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory could look like:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n\u251c\u2500\u2500 new-consensus.pem\n\u251c\u2500\u2500 new-node.pem\n\u2514\u2500\u2500 old-consensus.pem\n\u2514\u2500\u2500 old-node.pem\n\n0 directories, 4 file\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"old-*.pem"})," files are the original key store and ",(0,i.jsx)(n.code,{children:"new-*.pem"})," could correspond to the new identity created while setting up the node in the new server."]}),"\n",(0,i.jsxs)(n.p,{children:["Since we have ",(0,i.jsx)(n.code,{children:"[signer]"})," set to the default values, in particular:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-toml",children:'[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["We'd be required to change and switch to the preferred keys. The identity is switch to the provided values once the node is restarted. Thus, we can switch to any identity by changing the ",(0,i.jsx)(n.code,{children:"[signer]"})," ",(0,i.jsx)(n.code,{children:"consensus_key_path"})," and ",(0,i.jsx)(n.code,{children:"node_key_path"})," pathname values anytime as long we restart the server successfully."]}),"\n",(0,i.jsx)(n.p,{children:"To verify which keys are loaded by the Lightning CLI run the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn keys show\n"})}),"\n",(0,i.jsx)(n.p,{children:"You'd find the public keys in the output, which can be used for comparision and should be different everytime the configuration changes and reloaded. Here's an example of the output:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Node Public Key: RwPpr35H5AAfWwSDFxwYuJv5TA8PWUd2pdBg+UKsORc=\nConsensus Public Key: s36g09qQzaaOJxi0UZDRCXj3HUUWjaGiYrQV6Ylo9Ih6jMvrnxM5s1OpBnsEj5R1AVYcuxlnVR+oyEjgJ3WpI5LOHSN1Q6Zur33vka3IachBEIKIbsiXMJW16vu4n4bG\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The PEM files can be named as you wish, but by default we like to keep it sound to avoid confusion and make it as clear as possible."})}),"\n",(0,i.jsx)(n.h2,{id:"backing-up-the-keystore",children:"Backing up the keystore"}),"\n",(0,i.jsx)(n.p,{children:"When dealing with Fleek Network it's crucial to always be aware of the identity. You should backup private keys in case the unexpected happens, as it's impossible to recover the identity in any other way, including the core team, any other person or system."}),"\n",(0,i.jsxs)(n.p,{children:["Backing up your keystore pem files are crucial to ensure the safety and accessibility of your identity on the Fleek Network. For example, if your ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"})," is deleted you'll still be able to restore it if you have backed it up properly."]}),"\n",(0,i.jsx)(n.p,{children:"There are many ways to make identity backups, each with its own benefits and drawbacks. At risk of oversimplifying, we'll focus on a simple manual approach to expose some principles you should have awareness."}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"The security is never stronger than its weakest link, and it is very likely that the weakest link is not the method itself. It's pointless to encrypt the backup archive with sophisticated methods when the passphrase is weak or of an easy guess."})}),"\n",(0,i.jsx)(n.p,{children:"None of the methods described here are being endorsed by the Fleek Network team use the knowledge provided here for educational purposes only and at your own risk."}),"\n",(0,i.jsx)(n.h3,{id:"lower-security",children:"Lower security"}),"\n",(0,i.jsx)(n.p,{children:"If you opt for the lowest level of security, you can use zip and unzip. The man page of zip described the encryption algorithm used to be weaker than PGP."}),"\n",(0,i.jsxs)(n.p,{children:["To zip and encrypto the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory run:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (remember)\nzip --encrypt -r keystore.zip.enc $HOME/.lightning/keystore\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To unzip and decrypt the ",(0,i.jsx)(n.code,{children:"keystore.zip.enc"}),", you'd run:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (recall)\nunzip keystore.zip.enc -d $HOME/.lightning/keystore\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["We provide the unzip destiny target to the flag ",(0,i.jsx)(n.code,{children:"-d"}),". The unzip process outputs the files onto the desired location ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"}),", thus overriding any contents. If you have any files in the destiny target directory it'll be overriden, effectively replacing with the output of the unzipped directory content, so make sure you backup any files as required."]})}),"\n",(0,i.jsx)(n.h3,{id:"higher-security",children:"Higher security"}),"\n",(0,i.jsxs)(n.p,{children:["Create a ",(0,i.jsx)(n.code,{children:"Tar"})," archive, which will contain the target directory, files and the Tar stores all of the relative paths in the tarball itself."]}),"\n",(0,i.jsxs)(n.p,{children:["Create a ",(0,i.jsx)(n.code,{children:"tarbar"})," by executing:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'tar -cf "keystore.tar" $HOME/.lightning/keystore\n'})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"keystore.tar"})," should be in the current work directory."]}),"\n",(0,i.jsxs)(n.p,{children:["Use ",(0,i.jsx)(n.code,{children:"gpg"})," with the ",(0,i.jsx)(n.a,{href:"https://www.gnupg.org/gph/en/manual/x110.html",children:"symmetric option"}),", it creates the keys for that file and request a password to protect them. If you are familiar with asymmetric ",(0,i.jsx)(n.code,{children:"gpg"}),", it's similar, but it's not signed with your public key or such."]}),"\n",(0,i.jsx)(n.p,{children:"The encryption command is:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --symmetric --cipher-algo AES256 keystore.tar\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"keystore.tar.asc"})," should be in the current work directory."]}),"\n",(0,i.jsxs)(n.p,{children:["To decrypt the ",(0,i.jsx)(n.code,{children:"keystore.tar.asc"})," file, enter:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --output keystore.tar --decrypt keystore.tar.asc\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To extract the ",(0,i.jsx)(n.code,{children:"keystore.tar"})," is simple, but be aware that it unarchives with the original directory structure, which might be a bit confusing. So, we'll create a new temporary directory for our example that will use to extract to."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"mkdir $HOME/tar_keystore_extract\n"})}),"\n",(0,i.jsx)(n.p,{children:"Now, run the command to extract to the target directory, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tar -xf keystore.tar -C $HOME/tar_keystore_extract\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"/home//.lightning/keystore"})," should be in the ",(0,i.jsx)(n.code,{children:"tar_keystore_extract"})," directory where you'll find the PEM files."]}),"\n",(0,i.jsx)(n.h3,{id:"storage",children:"Storage"}),"\n",(0,i.jsx)(n.p,{children:"The backup archive should only be accessible by yourself. If you decided to store it in a cloud storage provider, be aware of increased security risks. Cloud storage is convenient, but it ultimately puts data into the hands of others. If you're not particularly concerned, or have confidence about the encryption of the files, then that's at your own risk. But it's recommended to store in a physical hard drive that remains disconnected from computers and network devices."}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"If you use cloud storage to store your sensitive data, encryption should be your first line of defense. Encrypting files before uploading them to the cloud is crucial to reduce others from accessing information without your permissions and knowledge."})}),"\n",(0,i.jsx)(n.p,{children:"Remember that the security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."}),"\n",(0,i.jsx)(n.h2,{id:"loading-keys-on-runtime",children:"Loading keys on runtime"}),"\n",(0,i.jsxs)(n.p,{children:["As described in the section ",(0,i.jsx)(n.a,{href:"#configuration-file",children:"configuration files"})," the default location of the ",(0,i.jsx)(n.code,{children:".lightning"})," system configuration directory is ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"})," holds the information of where the Lightning CLI node process should pull the keystore pem files. The location of the pem files can be placed anywhere the node process has permissions to read."]}),"\n",(0,i.jsxs)(n.p,{children:["When unarchiving the backup files, the keystore directory or pem files should be placed in the directory declared in the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),". That is if the location is the one specified on the runtime\u2013the command declared to launch and run the lightning service, that has the optional ",(0,i.jsx)(n.code,{children:"-c"})," configuration flag that takes any custom location which overrides the default ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),"."]}),"\n",(0,i.jsxs)(n.admonition,{type:"caution",children:[(0,i.jsxs)(n.p,{children:["On runtime, the Lightning service can have specified a configuration file in any readable location. If a configuration pathname isn't passed, it'll default to the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),". It's important to understand this to avoid confusion."]}),(0,i.jsx)(n.p,{children:"The service that starts with:"}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /root/custom-configuration.toml run\n"})}),(0,i.jsx)(n.p,{children:"Can have complete different settings from any of the following:"}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home/lgtn/.lightning/config.toml run\n"})}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c ~/.lightning/config.toml run\n"})}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn run\n"})}),(0,i.jsx)(n.p,{children:"Due to the fact that any of the fails above might contain different settings declared in the file body."})]}),"\n",(0,i.jsx)(n.p,{children:"For instance, we can imagine a scenario where our service is started with the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home/lgtn/.lightning/config.toml run\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Where the ",(0,i.jsx)(n.code,{children:"keystore"})," is placed under the parent directory ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning/"}),". Resulting in the configuration file have the following settings for the hypothetical username ",(0,i.jsx)(n.code,{children:"lgtn"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["On the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install instructions"})," provided by the documentation, a ",(0,i.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd service unit"})," is recommended to allow the user control the Lightning service via systemctl. The Systemd service unit file should contain the recommended usage of ",(0,i.jsx)(n.code,{children:"-c"})," configuration. If you have followed the recommendations it should be familiar."]})}),"\n",(0,i.jsx)(n.h2,{id:"restoring-the-keystore",children:"Restoring the keystore"}),"\n",(0,i.jsx)(o.ZP,{}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"We've walked through most basics of where the configuration file is located, the configuration settings we use to set up and run the node, the different configuration sections we have, and most importantly the identity section."}),"\n",(0,i.jsxs)(n.p,{children:["Additionally, a brief guide on the ",(0,i.jsx)(n.a,{href:"#identity",children:"identity"}),", more specifically an introduction to the ",(0,i.jsx)(n.a,{href:"#type-of-keys",children:"type of keys"})," and ",(0,i.jsx)(n.a,{href:"#key-privacy",children:"key privacy"}),", which we find important to understand for anyone seriously interested in running a node by hinting into some system administration and security principles."]}),"\n",(0,i.jsx)(n.p,{children:"Separately, at risk of oversimpliying provided a brief introduction into the backup of the keystore directory."}),"\n",(0,i.jsx)(n.p,{children:"In the future, we'll introduce more advanced topics that will help you improve the knowledge you get from this, but we are glad that you followed this guide and got some comprehension to help you manage the key store."}),"\n",(0,i.jsxs)(n.p,{children:["While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"})," or by opening a ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network",children:"PR"})," in any of our repositories."]}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on Github"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for all the best updates!"]}),"\n",(0,i.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5979:(e,n,t)=>{t.d(n,{ZP:()=>o});var i=t(5893),s=t(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["You can restore the keystore (Public Keys) by copying the directory to the ",(0,i.jsx)(n.code,{children:"~/.lightning"})," directory."]}),"\n",(0,i.jsx)(n.p,{children:"Let's assume that you know where your backup directory or files are located. To keep our instructions easy to follow, let's say that:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["The keystore and files are located under the hypothetical location ",(0,i.jsx)(n.code,{children:"/my-keystore-backup"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["The files in the ",(0,i.jsx)(n.code,{children:"/my-keystore-backup"})," are the following:"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"/my-keystore-backup\n\u251c\u2500\u2500 consensus.pem\n\u2514\u2500\u2500 node.pem\n\n1 directory, 2 files\n"})}),"\n",(0,i.jsx)(n.p,{children:"Considering the above for our example, you would have to run the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"mv /my-keystore-backup /home//.lightning/keystore\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Remember to replace the ",(0,i.jsx)(n.code,{children:""})," with the correct username for the setup. For example, if you have installed the Fleek Network with the username ",(0,i.jsx)(n.code,{children:"lgtn"})," that would be ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning/keystore"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["Once moved, remember to start the service, you can learn how to manage the service by reading the section ",(0,i.jsx)(n.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})]})}function o(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(r,{...e})}):r(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:r,communityMember:o=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:r,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:r,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},4110:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},4350:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(7294);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[909],{3616:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>h,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var i=t(5893),s=t(1151),r=t(3872),o=t(5979);const a={title:"Managing the keystore",hide_title:!0,slug:"managing-the-keystore",date:new Date("2023-11-14T12:00:00.000Z"),image:"./assets/managing-the-keystore.png?202311181211",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",category:"Tutorial",tags:["guide","keystore","public keys","private keys","keys"]},h=void 0,l={id:"Node Operators/managing-the-keystore",title:"Managing the keystore",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",source:"@site/guides/Node Operators/managing-the-keystore.md",sourceDirName:"Node Operators",slug:"/Node Operators/managing-the-keystore",permalink:"/guides/Node Operators/managing-the-keystore",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/managing-the-keystore.md",tags:[{label:"guide",permalink:"/guides/tags/guide"},{label:"keystore",permalink:"/guides/tags/keystore"},{label:"public keys",permalink:"/guides/tags/public-keys"},{label:"private keys",permalink:"/guides/tags/private-keys"},{label:"keys",permalink:"/guides/tags/keys"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Managing the keystore",hide_title:!0,slug:"managing-the-keystore",date:"2023-11-14T12:00:00.000Z",image:"./assets/managing-the-keystore.png?202311181211",description:"The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any supported system you\u2019re migrating to",category:"Tutorial",tags:["guide","keystore","public keys","private keys","keys"]},sidebar:"defaultSidebar",previous:{title:"How to manage log files",permalink:"/guides/Node Operators/how-to-manage-log-files"},next:{title:"Running a node in Docker",permalink:"/guides/Node Operators/running-a-node-in-docker"}},d={image:t(4110).Z},c=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Configuration file",id:"configuration-file",level:2},{value:"Locating the file",id:"locating-the-file",level:3},{value:"Configuration sections",id:"configuration-sections",level:3},{value:"Type of keys",id:"type-of-keys",level:3},{value:"Key privacy",id:"key-privacy",level:3},{value:"Identity selection",id:"identity-selection",level:3},{value:"Backing up the keystore",id:"backing-up-the-keystore",level:2},{value:"Lower security",id:"lower-security",level:3},{value:"Higher security",id:"higher-security",level:3},{value:"Storage",id:"storage",level:3},{value:"Loading keys on runtime",id:"loading-keys-on-runtime",level:2},{value:"Restoring the keystore",id:"restoring-the-keystore",level:2},{value:"Conclusion",id:"conclusion",level:2}];function p(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Managing the keystore",src:t(4350).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network incentivizes participation by rewarding its node providers. A node is identifiable by an identity, which the reward mechanism uses to identify the node to reward it."}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsxs)(n.p,{children:["At time of writing the rewards mechanism hasn't yet been introduced, read the ",(0,i.jsx)(n.a,{href:"https://blog.fleek.network/post/fleek-network-testnet-plans",children:"testnet plans"})," to get a high level perspective over the plans. A token and economics paper should be released in the future."]})}),"\n",(0,i.jsxs)(n.p,{children:["We'll use the term identity to describe the key store declared in the configuration, in our case ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail",children:"PEM"})," files. The content of the PEM files and the file itself should be kept secret."]}),"\n",(0,i.jsxs)(n.p,{children:["The key store is in the file system and the location is defined in the Fleek Network ",(0,i.jsx)(n.code,{children:"~/.lightning/config.toml"}),", as a private key stored in an identity named PEM file (by default ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"}),"). It's essential to understand this, as you may want to copy the identity to a new server setup, to persist the identity accross to the new server setup."]}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"Security is achieved by issuing users private cryptographic keys. Only the holder of the private key has access to sensitive information, such as an identity, which relates to reputation, rewards, etc. The security of the private key is the responsibility of the user. Unfortunately, Fleek Network is unable to help you regain access to your private key if you've lost or failed to secure it. The private keys are your responsibility."})}),"\n",(0,i.jsxs)(n.p,{children:["The following will guide you through some of the fundamentals to help understand how to manage the key store at the very basics, and help you persist the key store identity, in any ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"supported system"})," you're migrating to."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsxs)(n.li,{children:["A basic understanding of ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Public-key_cryptography",children:"how public key cryptography works"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"configuration-file",children:"Configuration file"}),"\n",(0,i.jsx)(n.h3,{id:"locating-the-file",children:"Locating the file"}),"\n",(0,i.jsxs)(n.p,{children:["The Lightning CLI has a configuration file in the home directory of the user, which by default is located in the path ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"})," or ",(0,i.jsx)(n.code,{children:"~/.lightning"})," under the name ",(0,i.jsx)(n.code,{children:"config.toml"}),". It's generally described as ",(0,i.jsx)(n.code,{children:"~/.lightning/config.toml"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The tilde in ",(0,i.jsx)(n.code,{children:"~/.lightning"})," represents ",(0,i.jsx)(n.code,{children:"$HOME"})," which is simpler, but we'll use ",(0,i.jsx)(n.code,{children:"$HOME"})," to make it easy to follow."]})}),"\n",(0,i.jsxs)(n.p,{children:["If you're following the install recommendations you should be logged in with a ",(0,i.jsx)(n.strong,{children:"sudoer"})," account. For our guide, let's imagine that the ",(0,i.jsx)(n.strong,{children:"sudoer"})," username we are logged in with is ",(0,i.jsx)(n.strong,{children:"lgtn"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The word ",(0,i.jsx)(n.strong,{children:"sudo"}),' is the abbreviation of the term "super user do". As the name suggests, it is the privilege that a super user, such as an administrator has to do whatever it wants in the system. A super user can be an administrator, like the ',(0,i.jsx)(n.strong,{children:"root"})," or what we described here as a user in the group ",(0,i.jsx)(n.strong,{children:"sudo"})," aka ",(0,i.jsx)(n.strong,{children:"sudoer"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"If you are logged in with a username, that'd be:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home//.lightning/config.toml\n"})}),"\n",(0,i.jsxs)(n.p,{children:["For our example for user ",(0,i.jsx)(n.code,{children:"lgtn"})," that is:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home/lgtn/.lightning/config.toml\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you log in with another user, let's say ",(0,i.jsx)(n.code,{children:"fleek"})," it'd be:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home/fleek/.lightning/config.toml\n"})}),"\n",(0,i.jsx)(n.p,{children:"At any time, you can check which user you are logged in with by running the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"whoami\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of our user ",(0,i.jsx)(n.code,{children:"lgtn"}),", which for the command above outputs:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["To switch to a particular user, you can run the command ",(0,i.jsx)(n.code,{children:"su "})," e.g. for the user ",(0,i.jsx)(n.strong,{children:"lgtn"})," we would execute the command ",(0,i.jsx)(n.code,{children:"su lgtn"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["Now that you know where to locate the configuration file for any given user you are logged in with, learn about the ",(0,i.jsx)(n.a,{href:"#configuration-sections",children:"Configuration sections"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"configuration-sections",children:"Configuration sections"}),"\n",(0,i.jsxs)(n.p,{children:["The Fleek Network node configuration settings are located in the path ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),", and it's organized by configuration sections."]}),"\n",(0,i.jsx)(n.p,{children:"At the time of writing, we have a TOML file with sections. Here are some examples amongst others:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"application"}),"\n",(0,i.jsx)(n.li,{children:"origin-ipfs"}),"\n",(0,i.jsx)(n.li,{children:"rpc"}),"\n",(0,i.jsx)(n.li,{children:"signer"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Each of the sections holds several property names and values. If you are accustomed to the ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/JSON",children:"JSON"})," or ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/YAML",children:"YAML"})," formats, you'll find the TOML format a bit similar (if you'd like to learn more about the TOML file format, read about it ",(0,i.jsx)(n.a,{href:"https://toml.io/en/",children:"here"}),")."]}),"\n",(0,i.jsx)(n.p,{children:"By default, and at time of writing the Lightning CLI configuration file (config.toml) is similar to:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'[BLANK]\n\n[application]\ndb_path = "/home/lgtn/.lightning/data/app_db"\nmode = "Prod"\nstorage = "RocksDb"\ntestnet = true\n\n[blockserver]\naddress = "0.0.0.0:4211"\n\n[broadcast]\naddress = "0.0.0.0:4200"\n\n[consensus]\nstore_path = "/home/lgtn/.lightning/data/narwhal_store"\n\n[dht]\naddress = "0.0.0.0:8101"\nbootstrappers = []\n\n[fetcher]\n\n[fsstore]\nroot = "/home/lgtn/.lightning/blockstore"\n\n[[handshake.transport]]\nsignal_address = "0.0.0.0:4210"\ntype = "WebRTC"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[handshake.worker]]\ntype = "AsyncWorker"\n\n[[origin-ipfs.gateways]]\nauthority = "ipfs.io"\nprotocol = "Https"\n\n[[origin-ipfs.gateways]]\nauthority = "fleek.ipfs.io"\nprotocol = "Https"\n\n[[origin-ipfs.gateways]]\nauthority = "ipfs.runfission.com"\nprotocol = "Https"\n\n[rep-collector]\nreporter_buffer_size = 5\n\n[resolver]\nstore_path = "/home/lgtn/.lightning/data/resolver_store"\n\n[rpc]\naddr = "0.0.0.0"\nport = 4230\n\n[service-executor]\nservices = [0, 1]\n\n[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n\n[topology]\ntesting_min_nodes = 9\ntesting_target_k = 8\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"Beware that the configuration file might look a bit different depending on the version you're running and the current development features in place by the Fleek Network core team. You shouldn't copy the example above and replace with yours, as this only servers for illustrative purposes."})}),"\n",(0,i.jsx)(n.p,{children:"Some advanced use cases might require dealing with the host and port number binding, depending on the service provider's needs and customization. We'll keep things simple and assume the default settings."}),"\n",(0,i.jsxs)(n.p,{children:["In this guide, we are interested in the ",(0,i.jsx)(n.code,{children:"[signer]"})," section settings for the ",(0,i.jsx)(n.code,{children:"consensus_key_path"})," and ",(0,i.jsx)(n.code,{children:"node_key_path"})," which by default is set to ",(0,i.jsx)(n.code,{children:"~/.lightning/keystore"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The identity is a text description for the Keystore and at the time of writing we have not yet implemented multiple identity management via the CLI. Thereupon, the identity value serves to find the filename match in the ",(0,i.jsx)(n.code,{children:"keystore_path"}),". This might change as we progress with development. Check the ",(0,i.jsx)(n.a,{href:"#identity-selection",children:"Identity selection"})," to learn more about it!"]})}),"\n",(0,i.jsx)(n.h3,{id:"type-of-keys",children:"Type of keys"}),"\n",(0,i.jsxs)(n.p,{children:["There are three types of keys related to the identity of a node and the account ownership. The keys are based in public-key cryptography, or asymmetric cryptography where each key pair consists of a public key and a corresponding private key. The keys are described in the section ",(0,i.jsx)(n.a,{href:"/docs/learn/the-network/#identity-on-the-fleek-network",children:"identity on the Fleek Network"})," as follows:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["A Node key (ConsensusPublicKey) is ",(0,i.jsx)(n.a,{href:"https://electriccoin.co/blog/new-snark-curve/",children:"BLS12-381"})," which facilitates the consensus algorithm or persistence of state, resilience and fault tolerance. Has multi-signature support, the ability to aggregate many signatures into one used for consensus committee when signing certificates"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["A Node Networking key (NodePublicKey) is ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/EdDSA",children:"Ed25519"})," used for the speed and performance of the network communications"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Account Owner keys are based on ",(0,i.jsx)(n.a,{href:"https://www.secg.org/sec2-v2.pdf",children:"secp256k1"}),", which corresponds to an Ethereum Address"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"For instance, a public key is open to anybody to see, and it represents a unique node identifier in the Fleek Network, a bit like a passport number. On the other hand, the private key is secret, and the operator is responsible to store it privately."}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network relies on cryptography, thus the Fleek Network team and anybody can access, compromise or manipulate the secrets of an identity. On the other hand, the public key can be used by anyone, Fleek Network included, to identify a node or send rewards to the address without jeopardizing identity security."}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about the identities on the Fleek Network ",(0,i.jsx)(n.a,{href:"/docs/learn/the-network/#identity-on-the-fleek-network",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"key-privacy",children:"Key privacy"}),"\n",(0,i.jsx)(n.p,{children:"If you don\u2019t keep your private keys secret, you'll have your node compromised."}),"\n",(0,i.jsx)(n.p,{children:"Here are a few examples of what you should not do:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Share the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory file content publicly"]}),"\n",(0,i.jsxs)(n.li,{children:["Track the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory files in a version control repository e.g. git"]}),"\n",(0,i.jsxs)(n.li,{children:['Have poor "rights" permissions in UNIX systems e.g. everyone can read, delete, modify ',(0,i.jsx)(n.code,{children:"$HOME/.lightning"})]}),"\n",(0,i.jsx)(n.li,{children:"Allow anyone to access the node provider physically without any access control to the operating and file systems e.g. a VPS provider"}),"\n",(0,i.jsxs)(n.li,{children:["Get rid of a hard drive unformatted or blind erased by selling to somebody or dumping in the bin, which contains ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"There are many other ways of getting compromised, but hopefully, the ones put above give you a good starter into the subject."}),"\n",(0,i.jsx)(n.p,{children:"Remember, the node provider is the only one responsible when managing the key store. Neither Fleek Network nor the most sophisticated AI system presently can compromise the cryptography in use to help you out. You are fully responsible for securing and retaining your private keys."}),"\n",(0,i.jsx)(n.h3,{id:"identity-selection",children:"Identity selection"}),"\n",(0,i.jsx)(n.p,{children:"Multiple identity management is yet to be implemented but in any case, some users might find it trivial to keep multiple identities and switch between them referencing them by name. The following section is not advocating this approach but sharing some approaches that can help certain use-cases."}),"\n",(0,i.jsxs)(n.p,{children:["Let's suppose that we've recently moved to a new server setup and copied our previous server keystore keys as ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"})," and renamed the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore/*.pem"})," to ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore/new-*.pem"}),"."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["We are using a wildcard ",(0,i.jsx)(n.code,{children:"*"})," to reduce verbosity. The wildcard means as replacement for all the filenames encountered in the path and extension without having to name them individually as we know they are ",(0,i.jsx)(n.code,{children:"consensus.pem"})," and ",(0,i.jsx)(n.code,{children:"node.pem"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["To illustrate this scenario, here's an example of how our ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory could look like:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:".\n\u251c\u2500\u2500 new-consensus.pem\n\u251c\u2500\u2500 new-node.pem\n\u2514\u2500\u2500 old-consensus.pem\n\u2514\u2500\u2500 old-node.pem\n\n0 directories, 4 file\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"old-*.pem"})," files are the original key store and ",(0,i.jsx)(n.code,{children:"new-*.pem"})," could correspond to the new identity created while setting up the node in the new server."]}),"\n",(0,i.jsxs)(n.p,{children:["Since we have ",(0,i.jsx)(n.code,{children:"[signer]"})," set to the default values, in particular:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-toml",children:'[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["We'd be required to change and switch to the preferred keys. The identity is switch to the provided values once the node is restarted. Thus, we can switch to any identity by changing the ",(0,i.jsx)(n.code,{children:"[signer]"})," ",(0,i.jsx)(n.code,{children:"consensus_key_path"})," and ",(0,i.jsx)(n.code,{children:"node_key_path"})," pathname values anytime as long we restart the server successfully."]}),"\n",(0,i.jsx)(n.p,{children:"To verify which keys are loaded by the Lightning CLI run the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn keys show\n"})}),"\n",(0,i.jsx)(n.p,{children:"You'd find the public keys in the output, which can be used for comparision and should be different everytime the configuration changes and reloaded. Here's an example of the output:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Node Public Key: RwPpr35H5AAfWwSDFxwYuJv5TA8PWUd2pdBg+UKsORc=\nConsensus Public Key: s36g09qQzaaOJxi0UZDRCXj3HUUWjaGiYrQV6Ylo9Ih6jMvrnxM5s1OpBnsEj5R1AVYcuxlnVR+oyEjgJ3WpI5LOHSN1Q6Zur33vka3IachBEIKIbsiXMJW16vu4n4bG\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The PEM files can be named as you wish, but by default we like to keep it sound to avoid confusion and make it as clear as possible."})}),"\n",(0,i.jsx)(n.h2,{id:"backing-up-the-keystore",children:"Backing up the keystore"}),"\n",(0,i.jsx)(n.p,{children:"When dealing with Fleek Network it's crucial to always be aware of the identity. You should backup private keys in case the unexpected happens, as it's impossible to recover the identity in any other way, including the core team, any other person or system."}),"\n",(0,i.jsxs)(n.p,{children:["Backing up your keystore pem files are crucial to ensure the safety and accessibility of your identity on the Fleek Network. For example, if your ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"})," is deleted you'll still be able to restore it if you have backed it up properly."]}),"\n",(0,i.jsx)(n.p,{children:"There are many ways to make identity backups, each with its own benefits and drawbacks. At risk of oversimplifying, we'll focus on a simple manual approach to expose some principles you should have awareness."}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"The security is never stronger than its weakest link, and it is very likely that the weakest link is not the method itself. It's pointless to encrypt the backup archive with sophisticated methods when the passphrase is weak or of an easy guess."})}),"\n",(0,i.jsx)(n.p,{children:"None of the methods described here are being endorsed by the Fleek Network team use the knowledge provided here for educational purposes only and at your own risk."}),"\n",(0,i.jsx)(n.h3,{id:"lower-security",children:"Lower security"}),"\n",(0,i.jsx)(n.p,{children:"If you opt for the lowest level of security, you can use zip and unzip. The man page of zip described the encryption algorithm used to be weaker than PGP."}),"\n",(0,i.jsxs)(n.p,{children:["To zip and encrypto the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"})," directory run:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (remember)\nzip --encrypt -r keystore.zip.enc $HOME/.lightning/keystore\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To unzip and decrypt the ",(0,i.jsx)(n.code,{children:"keystore.zip.enc"}),", you'd run:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# It'll prompt for password (recall)\nunzip keystore.zip.enc -d $HOME/.lightning/keystore\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["We provide the unzip destiny target to the flag ",(0,i.jsx)(n.code,{children:"-d"}),". The unzip process outputs the files onto the desired location ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/keystore"}),", thus overriding any contents. If you have any files in the destiny target directory it'll be overriden, effectively replacing with the output of the unzipped directory content, so make sure you backup any files as required."]})}),"\n",(0,i.jsx)(n.h3,{id:"higher-security",children:"Higher security"}),"\n",(0,i.jsxs)(n.p,{children:["Create a ",(0,i.jsx)(n.code,{children:"Tar"})," archive, which will contain the target directory, files and the Tar stores all of the relative paths in the tarball itself."]}),"\n",(0,i.jsxs)(n.p,{children:["Create a ",(0,i.jsx)(n.code,{children:"tarbar"})," by executing:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'tar -cf "keystore.tar" $HOME/.lightning/keystore\n'})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"keystore.tar"})," should be in the current work directory."]}),"\n",(0,i.jsxs)(n.p,{children:["Use ",(0,i.jsx)(n.code,{children:"gpg"})," with the ",(0,i.jsx)(n.a,{href:"https://www.gnupg.org/gph/en/manual/x110.html",children:"symmetric option"}),", it creates the keys for that file and request a password to protect them. If you are familiar with asymmetric ",(0,i.jsx)(n.code,{children:"gpg"}),", it's similar, but it's not signed with your public key or such."]}),"\n",(0,i.jsx)(n.p,{children:"The encryption command is:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --symmetric --cipher-algo AES256 keystore.tar\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"keystore.tar.asc"})," should be in the current work directory."]}),"\n",(0,i.jsxs)(n.p,{children:["To decrypt the ",(0,i.jsx)(n.code,{children:"keystore.tar.asc"})," file, enter:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo gpg -a --output keystore.tar --decrypt keystore.tar.asc\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To extract the ",(0,i.jsx)(n.code,{children:"keystore.tar"})," is simple, but be aware that it unarchives with the original directory structure, which might be a bit confusing. So, we'll create a new temporary directory for our example that will use to extract to."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"mkdir $HOME/tar_keystore_extract\n"})}),"\n",(0,i.jsx)(n.p,{children:"Now, run the command to extract to the target directory, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"tar -xf keystore.tar -C $HOME/tar_keystore_extract\n"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"/home//.lightning/keystore"})," should be in the ",(0,i.jsx)(n.code,{children:"tar_keystore_extract"})," directory where you'll find the PEM files."]}),"\n",(0,i.jsx)(n.h3,{id:"storage",children:"Storage"}),"\n",(0,i.jsx)(n.p,{children:"The backup archive should only be accessible by yourself. If you decided to store it in a cloud storage provider, be aware of increased security risks. Cloud storage is convenient, but it ultimately puts data into the hands of others. If you're not particularly concerned, or have confidence about the encryption of the files, then that's at your own risk. But it's recommended to store in a physical hard drive that remains disconnected from computers and network devices."}),"\n",(0,i.jsx)(n.admonition,{type:"caution",children:(0,i.jsx)(n.p,{children:"If you use cloud storage to store your sensitive data, encryption should be your first line of defense. Encrypting files before uploading them to the cloud is crucial to reduce others from accessing information without your permissions and knowledge."})}),"\n",(0,i.jsx)(n.p,{children:"Remember that the security of the private key is the responsibility of the user. Unfortunately, the Fleek Network team and any others are unable to help regain access to private key if lost or failed to secure them. The private keys are the user responsibility. The Fleek Network team doesn't endorse any methods of encryption and storage, the methods described here are for educational purposes only."}),"\n",(0,i.jsx)(n.h2,{id:"loading-keys-on-runtime",children:"Loading keys on runtime"}),"\n",(0,i.jsxs)(n.p,{children:["As described in the section ",(0,i.jsx)(n.a,{href:"#configuration-file",children:"configuration files"})," the default location of the ",(0,i.jsx)(n.code,{children:".lightning"})," system configuration directory is ",(0,i.jsx)(n.code,{children:"$HOME/.lightning"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"})," holds the information of where the Lightning CLI node process should pull the keystore pem files. The location of the pem files can be placed anywhere the node process has permissions to read."]}),"\n",(0,i.jsxs)(n.p,{children:["When unarchiving the backup files, the keystore directory or pem files should be placed in the directory declared in the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),". That is if the location is the one specified on the runtime\u2013the command declared to launch and run the lightning service, that has the optional ",(0,i.jsx)(n.code,{children:"-c"})," configuration flag that takes any custom location which overrides the default ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),"."]}),"\n",(0,i.jsxs)(n.admonition,{type:"caution",children:[(0,i.jsxs)(n.p,{children:["On runtime, the Lightning service can have specified a configuration file in any readable location. If a configuration pathname isn't passed, it'll default to the ",(0,i.jsx)(n.code,{children:"$HOME/.lightning/config.toml"}),". It's important to understand this to avoid confusion."]}),(0,i.jsx)(n.p,{children:"The service that starts with:"}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /root/custom-configuration.toml run\n"})}),(0,i.jsx)(n.p,{children:"Can have complete different settings from any of the following:"}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home/lgtn/.lightning/config.toml run\n"})}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c ~/.lightning/config.toml run\n"})}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn run\n"})}),(0,i.jsx)(n.p,{children:"Due to the fact that any of the fails above might contain different settings declared in the file body."})]}),"\n",(0,i.jsx)(n.p,{children:"For instance, we can imagine a scenario where our service is started with the command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home/lgtn/.lightning/config.toml run\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Where the ",(0,i.jsx)(n.code,{children:"keystore"})," is placed under the parent directory ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning/"}),". Resulting in the configuration file have the following settings for the hypothetical username ",(0,i.jsx)(n.code,{children:"lgtn"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'[signer]\nconsensus_key_path = "/home/lgtn/.lightning/keystore/consensus.pem"\nnode_key_path = "/home/lgtn/.lightning/keystore/node.pem"\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["On the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install instructions"})," provided by the documentation, a ",(0,i.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd service unit"})," is recommended to allow the user control the Lightning service via systemctl. The Systemd service unit file should contain the recommended usage of ",(0,i.jsx)(n.code,{children:"-c"})," configuration. If you have followed the recommendations it should be familiar."]})}),"\n",(0,i.jsx)(n.h2,{id:"restoring-the-keystore",children:"Restoring the keystore"}),"\n",(0,i.jsx)(o.ZP,{}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"We've walked through most basics of where the configuration file is located, the configuration settings we use to set up and run the node, the different configuration sections we have, and most importantly the identity section."}),"\n",(0,i.jsxs)(n.p,{children:["Additionally, a brief guide on the ",(0,i.jsx)(n.a,{href:"#identity",children:"identity"}),", more specifically an introduction to the ",(0,i.jsx)(n.a,{href:"#type-of-keys",children:"type of keys"})," and ",(0,i.jsx)(n.a,{href:"#key-privacy",children:"key privacy"}),", which we find important to understand for anyone seriously interested in running a node by hinting into some system administration and security principles."]}),"\n",(0,i.jsx)(n.p,{children:"Separately, at risk of oversimpliying provided a brief introduction into the backup of the keystore directory."}),"\n",(0,i.jsx)(n.p,{children:"In the future, we'll introduce more advanced topics that will help you improve the knowledge you get from this, but we are glad that you followed this guide and got some comprehension to help you manage the key store."}),"\n",(0,i.jsxs)(n.p,{children:["While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord"})," or by opening a ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network",children:"PR"})," in any of our repositories."]}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on Github"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for all the best updates!"]}),"\n",(0,i.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5979:(e,n,t)=>{t.d(n,{ZP:()=>o});var i=t(5893),s=t(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["You can restore the keystore (Public Keys) by copying the directory to the ",(0,i.jsx)(n.code,{children:"~/.lightning"})," directory."]}),"\n",(0,i.jsx)(n.p,{children:"Let's assume that you know where your backup directory or files are located. To keep our instructions easy to follow, let's say that:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["The keystore and files are located under the hypothetical location ",(0,i.jsx)(n.code,{children:"/my-keystore-backup"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["The files in the ",(0,i.jsx)(n.code,{children:"/my-keystore-backup"})," are the following:"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"/my-keystore-backup\n\u251c\u2500\u2500 consensus.pem\n\u2514\u2500\u2500 node.pem\n\n1 directory, 2 files\n"})}),"\n",(0,i.jsx)(n.p,{children:"Considering the above for our example, you would have to run the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"mv /my-keystore-backup /home//.lightning/keystore\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Remember to replace the ",(0,i.jsx)(n.code,{children:""})," with the correct username for the setup. For example, if you have installed the Fleek Network with the username ",(0,i.jsx)(n.code,{children:"lgtn"})," that would be ",(0,i.jsx)(n.code,{children:"/home/lgtn/.lightning/keystore"}),"."]})}),"\n",(0,i.jsxs)(n.p,{children:["Once moved, remember to start the service, you can learn how to manage the service by reading the section ",(0,i.jsx)(n.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})]})}function o(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(r,{...e})}):r(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:r,communityMember:o=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:r,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:r,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},4110:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},4350:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/managing-the-keystore-fe4cdb19d2f59c54bcf864b0e069b535.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(7294);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b6134d1.ec4f85a2.js b/assets/js/5b6134d1.cacd68da.js similarity index 99% rename from assets/js/5b6134d1.ec4f85a2.js rename to assets/js/5b6134d1.cacd68da.js index a1cb09146..b3b062e3f 100644 --- a/assets/js/5b6134d1.ec4f85a2.js +++ b/assets/js/5b6134d1.cacd68da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9752],{1586:(e,n,s)=>{s.d(n,{ZP:()=>o});var t=s(5893),i=s(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["In the ",(0,t.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,t.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,t.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,t.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,t.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["Replace the ",(0,t.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,t.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,t.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,t.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["For example, if your username is ",(0,t.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Once modified, you can run a ",(0,t.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,t.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,t.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,t.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(r,{...e})}):r(e)}},2421:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>l,metadata:()=>h,toc:()=>c});var t=s(5893),i=s(1151),r=s(3872),o=s(1586);const l={title:"File permissions and Ownership",slug:"file-permissions-and-ownership",hide_title:!0,tags:["ownership","file permissions","sudoer","root"]},a=void 0,h={id:"Lightning CLI/file-permissions-and-ownership",title:"File permissions and Ownership",description:"Ownership",source:"@site/references/Lightning CLI/file-permissions-and-ownership.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/file-permissions-and-ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/file-permissions-and-ownership.md",tags:[{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"},{label:"sudoer",permalink:"/references/tags/sudoer"},{label:"root",permalink:"/references/tags/root"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"File permissions and Ownership",slug:"file-permissions-and-ownership",hide_title:!0,tags:["ownership","file permissions","sudoer","root"]},sidebar:"defaultSidebar",previous:{title:"Error linking with cc",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1"},next:{title:"Frequently used commands for Native setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup"}},d={},c=[{value:"Ownership",id:"ownership",level:2},{value:"Using sudo to delegate permissions",id:"using-sudo-to-delegate-permissions",level:2},{value:"User $HOME directory",id:"user-home-directory",level:2},{value:"Set the locations of the user paths",id:"set-the-locations-of-the-user-paths",level:2},{value:"Set the configuration flag -c on the service unit file",id:"set-the-configuration-flag--c-on-the-service-unit-file",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"ownership",children:"Ownership"}),"\n",(0,t.jsx)(n.p,{children:"The user who installs the Fleek Network Lightning CLI matters, as it can own or delegate ownership of the dependencies and applications being installed."}),"\n",(0,t.jsx)(n.p,{children:"For example, if you have followed the install document recommendations and have:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Created a user ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Switched to the user ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Executed the installation process as ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n"]}),"\n",(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["The username can be anything, we are using the term ",(0,t.jsx)(n.strong,{children:"lgtn"})," as the example provided throughout our documentation. Select your username in accordance to your preferences."]})}),"\n",(0,t.jsx)(n.p,{children:"You'll find that it owns the following directories under the user home (/home/lgtn):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 10:27 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 12:29 .cargo\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 6 lgtn lgtn 4096 Sep 11 12:29 .rustup\ndrwxrwxr-x 3 lgtn lgtn 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Above, we have the listing properties set as ",(0,t.jsx)(n.strong,{children:"drwxrwxr-x"})," and the ownership ",(0,t.jsxs)(n.strong,{children:["lgtn",":lgtn"]}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["On the other hand, if you have done the installation process as ",(0,t.jsx)(n.strong,{children:"root"})," superuser, you'll find that:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["The location of the directories and files goes under the ",(0,t.jsx)(n.code,{children:"/root"})," pathname"]}),"\n",(0,t.jsxs)(n.li,{children:["The ownership is set to ",(0,t.jsxs)(n.strong,{children:["root",":root"]})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Learn more about ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/blog/blog/classic-sysadmin-understanding-linux-file-permissions",children:"file permissions"})," from the ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/",children:"Linux Foundation"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["To learn more about file permission on Linux, read the ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/blog/blog/classic-sysadmin-understanding-linux-file-permissions",children:"Understanding Linux File Permissions"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"using-sudo-to-delegate-permissions",children:"Using sudo to delegate permissions"}),"\n",(0,t.jsxs)(n.p,{children:["Consider file ownership and permissions to understand where the keystore is located. Take close attention when executing commands as an admin\u2013with or without ",(0,t.jsx)(n.strong,{children:"super user"})," (root) or ",(0,t.jsx)(n.strong,{children:"sudo"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If a command is executed without ",(0,t.jsx)(n.strong,{children:"sudo"})," then the generated output goes onto the ",(0,t.jsx)(n.strong,{children:"user"})," home."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lgtn keys generate\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Resulting in having the ",(0,t.jsx)(n.strong,{children:"keystore"})," saved onto ",(0,t.jsx)(n.code,{children:"/home/username/.lightning/keystore"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["On the other hand, if a command is executed with ",(0,t.jsx)(n.strong,{children:"sudo"})," then the generated output is delegated to ",(0,t.jsx)(n.strong,{children:"root"})," directory."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo lgtn keys generate\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Resulting in having the ",(0,t.jsx)(n.strong,{children:"keystore"})," saved onto ",(0,t.jsx)(n.code,{children:"/root/.lightning/keystore"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"user-home-directory",children:"User $HOME directory"}),"\n",(0,t.jsxs)(n.p,{children:["The home directory is a directory that contains the personal files of a particular user of the system. On Linux, the ",(0,t.jsx)(n.code,{children:"$HOME"})," environment variable is set by the login program, which sets the user `$HOME`` accordingly. A user's home goes by the username, the user who's logged in."]}),"\n",(0,t.jsx)(n.p,{children:"For this reason, a user can change to the home directory by executing:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd $HOME\n"})}),"\n",(0,t.jsxs)(n.p,{children:["A shorthand allows a user to refer to their home directory simply as ",(0,t.jsx)(n.code,{children:"~"})," (tilde), as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd ~\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["We can find that the HOME or ~ (tilde) is highly dependent on the user who's logged in. Since we know that the user might delegate to ",(0,t.jsx)(n.strong,{children:"root"})," by the usage of ",(0,t.jsx)(n.strong,{children:"sudo"}),", this can help troubleshoot and explain the location of our files e.g. the keystore. In the section ",(0,t.jsx)(n.a,{href:"#set-the-locations-of-the-user-paths",children:"Set the locations of the user paths"}),", we learn how to define the location of our user configuration paths to avoid confusion. By doing it we ensure that when running the service, the service picks the correct configuration paths for our user."]})}),"\n",(0,t.jsxs)(n.p,{children:["To learn more about the user $HOME directory read the wikipedia ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Home_directory",children:"Home directory"})," document."]}),"\n",(0,t.jsx)(n.h2,{id:"set-the-locations-of-the-user-paths",children:"Set the locations of the user paths"}),"\n",(0,t.jsx)(o.ZP,{}),"\n",(0,t.jsx)(n.h2,{id:"set-the-configuration-flag--c-on-the-service-unit-file",children:"Set the configuration flag -c on the service unit file"}),"\n",(0,t.jsxs)(n.p,{children:["The following section assumes that a System service unit has been declared, and you're using systemctl to control the service, as described in our ",(0,t.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd Service Setup"})," install section."]}),"\n",(0,t.jsxs)(n.p,{children:["Open and edit the ",(0,t.jsx)(n.strong,{children:"/etc/systemd/system/lightning.service"})," file."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Replace ",(0,t.jsx)(n.code,{children:""})," with YOUR username. For example, in the documentation we use the username ",(0,t.jsx)(n.strong,{children:"lgtn"}),", which means we'd replace ",(0,t.jsx)(n.code,{children:""})," with ",(0,t.jsx)(n.code,{children:"lgtn"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Make sure that the ExecStart is set correctly, including the ",(0,t.jsx)(n.code,{children:"-c"})]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For our example, as the username ",(0,t.jsx)(n.strong,{children:"lgtn"})," it would look like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,t.jsx)(n.p,{children:"When complete make sure the file is saved and the systemctl daemon is reloaded, as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Consequently, when a user manages the service via the systemctl, the Lightning CLI process will read the configuration file settings provided above. It includes the location of the user preferences, such as the keystore location amongst others, preventing confusion regardless of ",(0,t.jsx)(n.strong,{children:"root"})," delegation."]}),"\n",(0,t.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>i});s(7294);var t=s(5893);const i=e=>{let{image:n,name:s,title:i,url:r,communityMember:o=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:r,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:r,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>o});var t=s(7294);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9752],{1586:(e,n,s)=>{s.d(n,{ZP:()=>o});var t=s(5893),i=s(1151);function r(e){const n={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["In the ",(0,t.jsx)(n.code,{children:"/home//.lightning/config.toml"})," you'll find some and more of the following:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["The configuration properties and values presented above are a shorter version of what you'll find on your ",(0,t.jsx)(n.strong,{children:"configuration.toml"}),". We keep it short to make it easier to follow, do not copy and paste."]})}),"\n",(0,t.jsxs)(n.p,{children:["Find and replace all instances of ~ in the config file ",(0,t.jsx)(n.code,{children:"/home//.lightning/config.toml"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["Here's an example of how to do it using ",(0,t.jsx)(n.strong,{children:"sed"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home//.lightning|g" "/home//.lightning/config.toml"\n'})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["Replace the ",(0,t.jsx)(n.code,{children:""})," with your username. For example, if you have followed the recommendation to ",(0,t.jsx)(n.a,{href:"/docs/node/install#create-a-user",children:"create a user"})," it would look like ",(0,t.jsx)(n.code,{children:"/home/lgtn/.lightning/config.toml"})," for the username ",(0,t.jsx)(n.strong,{children:"lgtn"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["For example, if your username is ",(0,t.jsx)(n.code,{children:"lgtn"})," that'd look like this:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sed -i "s|~/.lightning|/home/lgtn/.lightning|g" "/home/lgtn/.lightning/config.toml"\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Once modified, you can run a ",(0,t.jsx)(n.code,{children:"cat"})," to see the content of the files to confirm it has been updated."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cat /home/lgtn/.lightning/config.toml\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For our example where we opted in for the username ",(0,t.jsx)(n.code,{children:"lgtn"})," that would look like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-toml",children:'[BLANK]\n\n[application]\ndb_path = "~/.lightning/data/app_db"\n\n[consensus]\nstore_path = "~/.lightning/data/narwhal_store"\n\n[fsstore]\nroot = "~/.lightning/blockstore"\n\n[resolver]\nstore_path = "~/.lightning/data/resolver_store"\n\n[signer]\nconsensus_key_path = "~/.lightning/keystore/consensus.pem"\nnode_key_path = "~/.lightning/keystore/node.pem"\n'})}),"\n",(0,t.jsx)(n.admonition,{title:"Warning",type:"caution",children:(0,t.jsx)(n.p,{children:"Bear in mind that we are keeping the content of the file short to make it easier to read and follow. The content of your configuration file should look slightly different, amongst these it should contain other properties and values. You should not copy and replace the content of your files with the ones presented here."})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(r,{...e})}):r(e)}},2421:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>l,metadata:()=>h,toc:()=>c});var t=s(5893),i=s(1151),r=s(3872),o=s(1586);const l={title:"File permissions and Ownership",slug:"file-permissions-and-ownership",hide_title:!0,tags:["ownership","file permissions","sudoer","root"]},a=void 0,h={id:"Lightning CLI/file-permissions-and-ownership",title:"File permissions and Ownership",description:"Ownership",source:"@site/references/Lightning CLI/file-permissions-and-ownership.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/file-permissions-and-ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/file-permissions-and-ownership.md",tags:[{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"},{label:"sudoer",permalink:"/references/tags/sudoer"},{label:"root",permalink:"/references/tags/root"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"File permissions and Ownership",slug:"file-permissions-and-ownership",hide_title:!0,tags:["ownership","file permissions","sudoer","root"]},sidebar:"defaultSidebar",previous:{title:"Error linking with cc",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1"},next:{title:"Frequently used commands for Native setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup"}},d={},c=[{value:"Ownership",id:"ownership",level:2},{value:"Using sudo to delegate permissions",id:"using-sudo-to-delegate-permissions",level:2},{value:"User $HOME directory",id:"user-home-directory",level:2},{value:"Set the locations of the user paths",id:"set-the-locations-of-the-user-paths",level:2},{value:"Set the configuration flag -c on the service unit file",id:"set-the-configuration-flag--c-on-the-service-unit-file",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"ownership",children:"Ownership"}),"\n",(0,t.jsx)(n.p,{children:"The user who installs the Fleek Network Lightning CLI matters, as it can own or delegate ownership of the dependencies and applications being installed."}),"\n",(0,t.jsx)(n.p,{children:"For example, if you have followed the install document recommendations and have:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Created a user ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Switched to the user ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n",(0,t.jsxs)(n.li,{children:["Executed the installation process as ",(0,t.jsx)(n.strong,{children:"lgtn"})]}),"\n"]}),"\n",(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["The username can be anything, we are using the term ",(0,t.jsx)(n.strong,{children:"lgtn"})," as the example provided throughout our documentation. Select your username in accordance to your preferences."]})}),"\n",(0,t.jsx)(n.p,{children:"You'll find that it owns the following directories under the user home (/home/lgtn):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"drwxr-x--- 6 lgtn lgtn 4096 Sep 12 10:27 .\ndrwxr-xr-x 3 root root 4096 Sep 11 12:28 ..\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 12:29 .cargo\ndrwxrwxr-x 5 lgtn lgtn 4096 Sep 11 15:25 .lightning\ndrwxrwxr-x 6 lgtn lgtn 4096 Sep 11 12:29 .rustup\ndrwxrwxr-x 3 lgtn lgtn 4096 Sep 11 12:28 fleek-network\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Above, we have the listing properties set as ",(0,t.jsx)(n.strong,{children:"drwxrwxr-x"})," and the ownership ",(0,t.jsxs)(n.strong,{children:["lgtn",":lgtn"]}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["On the other hand, if you have done the installation process as ",(0,t.jsx)(n.strong,{children:"root"})," superuser, you'll find that:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["The location of the directories and files goes under the ",(0,t.jsx)(n.code,{children:"/root"})," pathname"]}),"\n",(0,t.jsxs)(n.li,{children:["The ownership is set to ",(0,t.jsxs)(n.strong,{children:["root",":root"]})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Learn more about ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/blog/blog/classic-sysadmin-understanding-linux-file-permissions",children:"file permissions"})," from the ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/",children:"Linux Foundation"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["To learn more about file permission on Linux, read the ",(0,t.jsx)(n.a,{href:"https://www.linuxfoundation.org/blog/blog/classic-sysadmin-understanding-linux-file-permissions",children:"Understanding Linux File Permissions"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"using-sudo-to-delegate-permissions",children:"Using sudo to delegate permissions"}),"\n",(0,t.jsxs)(n.p,{children:["Consider file ownership and permissions to understand where the keystore is located. Take close attention when executing commands as an admin\u2013with or without ",(0,t.jsx)(n.strong,{children:"super user"})," (root) or ",(0,t.jsx)(n.strong,{children:"sudo"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["If a command is executed without ",(0,t.jsx)(n.strong,{children:"sudo"})," then the generated output goes onto the ",(0,t.jsx)(n.strong,{children:"user"})," home."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lgtn keys generate\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Resulting in having the ",(0,t.jsx)(n.strong,{children:"keystore"})," saved onto ",(0,t.jsx)(n.code,{children:"/home/username/.lightning/keystore"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:["On the other hand, if a command is executed with ",(0,t.jsx)(n.strong,{children:"sudo"})," then the generated output is delegated to ",(0,t.jsx)(n.strong,{children:"root"})," directory."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo lgtn keys generate\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Resulting in having the ",(0,t.jsx)(n.strong,{children:"keystore"})," saved onto ",(0,t.jsx)(n.code,{children:"/root/.lightning/keystore"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"user-home-directory",children:"User $HOME directory"}),"\n",(0,t.jsxs)(n.p,{children:["The home directory is a directory that contains the personal files of a particular user of the system. On Linux, the ",(0,t.jsx)(n.code,{children:"$HOME"})," environment variable is set by the login program, which sets the user `$HOME`` accordingly. A user's home goes by the username, the user who's logged in."]}),"\n",(0,t.jsx)(n.p,{children:"For this reason, a user can change to the home directory by executing:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd $HOME\n"})}),"\n",(0,t.jsxs)(n.p,{children:["A shorthand allows a user to refer to their home directory simply as ",(0,t.jsx)(n.code,{children:"~"})," (tilde), as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd ~\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["We can find that the HOME or ~ (tilde) is highly dependent on the user who's logged in. Since we know that the user might delegate to ",(0,t.jsx)(n.strong,{children:"root"})," by the usage of ",(0,t.jsx)(n.strong,{children:"sudo"}),", this can help troubleshoot and explain the location of our files e.g. the keystore. In the section ",(0,t.jsx)(n.a,{href:"#set-the-locations-of-the-user-paths",children:"Set the locations of the user paths"}),", we learn how to define the location of our user configuration paths to avoid confusion. By doing it we ensure that when running the service, the service picks the correct configuration paths for our user."]})}),"\n",(0,t.jsxs)(n.p,{children:["To learn more about the user $HOME directory read the wikipedia ",(0,t.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Home_directory",children:"Home directory"})," document."]}),"\n",(0,t.jsx)(n.h2,{id:"set-the-locations-of-the-user-paths",children:"Set the locations of the user paths"}),"\n",(0,t.jsx)(o.ZP,{}),"\n",(0,t.jsx)(n.h2,{id:"set-the-configuration-flag--c-on-the-service-unit-file",children:"Set the configuration flag -c on the service unit file"}),"\n",(0,t.jsxs)(n.p,{children:["The following section assumes that a System service unit has been declared, and you're using systemctl to control the service, as described in our ",(0,t.jsx)(n.a,{href:"/docs/node/install#systemd-service-setup",children:"Systemd Service Setup"})," install section."]}),"\n",(0,t.jsxs)(n.p,{children:["Open and edit the ",(0,t.jsx)(n.strong,{children:"/etc/systemd/system/lightning.service"})," file."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Replace ",(0,t.jsx)(n.code,{children:""})," with YOUR username. For example, in the documentation we use the username ",(0,t.jsx)(n.strong,{children:"lgtn"}),", which means we'd replace ",(0,t.jsx)(n.code,{children:""})," with ",(0,t.jsx)(n.code,{children:"lgtn"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Make sure that the ExecStart is set correctly, including the ",(0,t.jsx)(n.code,{children:"-c"})]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home//.lightning/config.toml run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,t.jsxs)(n.p,{children:["For our example, as the username ",(0,t.jsx)(n.strong,{children:"lgtn"})," it would look like:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,t.jsx)(n.p,{children:"When complete make sure the file is saved and the systemctl daemon is reloaded, as follows:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Consequently, when a user manages the service via the systemctl, the Lightning CLI process will read the configuration file settings provided above. It includes the location of the user preferences, such as the keystore location amongst others, preventing confusion regardless of ",(0,t.jsx)(n.strong,{children:"root"})," delegation."]}),"\n",(0,t.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>i});s(7294);var t=s(5893);const i=e=>{let{image:n,name:s,title:i,url:r,communityMember:o=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:r,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:r,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[o?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>o});var t=s(7294);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc389a1.226207a6.js b/assets/js/5bc389a1.95833e6d.js similarity index 99% rename from assets/js/5bc389a1.226207a6.js rename to assets/js/5bc389a1.95833e6d.js index 64ec16e4b..b19c13b12 100644 --- a/assets/js/5bc389a1.226207a6.js +++ b/assets/js/5bc389a1.95833e6d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9829],{7631:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>h,toc:()=>u});var i=t(5893),s=t(1151),o=t(3872);function r(e){const n={a:"a",admonition:"admonition",p:"p",...(0,s.a)(),...e.components};return(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsxs)(n.p,{children:["During testnet phase, you have to checkout to the testnet branch. For example, the first testnet branch name was ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/tree/testnet-alpha-1",children:"testnet-alpha-1"})," that you would have to be checked in order to run a node successfully. A list of the active branches can be found at anytime in the GitHub repository ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/branches",children:"active branches"}),". While we try our best to update documentation, guides, instructions or any other written content during development, there might be breaking changes that might take some time to reflect in our documents. To avoid disappointment, check into the correct branch or contribute by getting in touch with us, or sending a PR in the relevant context, thank you!"]})})}function a(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(r,{...e})}):r(e)}const l={title:"Updating Lightning",hide_title:!0,slug:"updating-lightning",date:new Date("2023-09-19T12:00:00.000Z"),image:"./assets/updating-lightning.png?202309191740",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",category:"Tutorial",tags:["update","rebuild","guide","setup","configuration"]},c=void 0,h={id:"Node Operators/updating-lightning",title:"Updating Lightning",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",source:"@site/guides/Node Operators/updating-lightning.md",sourceDirName:"Node Operators",slug:"/Node Operators/updating-lightning",permalink:"/guides/Node Operators/updating-lightning",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/updating-lightning.md",tags:[{label:"update",permalink:"/guides/tags/update"},{label:"rebuild",permalink:"/guides/tags/rebuild"},{label:"guide",permalink:"/guides/tags/guide"},{label:"setup",permalink:"/guides/tags/setup"},{label:"configuration",permalink:"/guides/tags/configuration"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Updating Lightning",hide_title:!0,slug:"updating-lightning",date:"2023-09-19T12:00:00.000Z",image:"./assets/updating-lightning.png?202309191740",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",category:"Tutorial",tags:["update","rebuild","guide","setup","configuration"]},sidebar:"defaultSidebar",previous:{title:"Transfering setup ownership",permalink:"/guides/Node Operators/transfering-setup-ownership"}},d={image:t(1506).Z},u=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Pulling the latest changes",id:"pulling-the-latest-changes",level:2},{value:"Switch to installer username",id:"switch-to-installer-username",level:3},{value:"Change directory to the source code",id:"change-directory-to-the-source-code",level:3},{value:"Checkout to branch",id:"checkout-to-branch",level:3},{value:"Pull the latest changes",id:"pull-the-latest-changes",level:3},{value:"Build the binary from the source code",id:"build-the-binary-from-the-source-code",level:2},{value:"Checkup the symlink setup",id:"checkup-the-symlink-setup",level:2},{value:"Systemd service",id:"systemd-service",level:2},{value:"Verify the setup",id:"verify-the-setup",level:3},{value:"Launching the node as a systemd service",id:"launching-the-node-as-a-systemd-service",level:3},{value:"Health check",id:"health-check",level:2},{value:"Conclusion",id:"conclusion",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Update Lightning",src:t(2913).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network's Lightning source code is updated frequently and thus keeping up with changes can be a bit of a chore and especially difficult for users who are trying to have it compiled for the first time, or updating the Lightning CLI binary for their operating systems. While we should have stable releases in the future, at the current phase of development, there's a requirement to follow the contributions directly in the repository: checking in and out, the commits you're interested in running."}),"\n",(0,i.jsxs)(n.p,{children:["In the following guide, we\u2019ll have a simple look into how to pull changes and update Lightning CLI on Linux, which we stick with Ubuntu for simplicity but should be easily transferrable to your ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"supported OS"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Some experience with Git"}),"\n",(0,i.jsx)(n.li,{children:"Have installed and set up the Lightning CLI and service"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"pulling-the-latest-changes",children:"Pulling the latest changes"}),"\n",(0,i.jsxs)(n.p,{children:["Check the latest contributions pushed to the Lightning CLI ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/commits/main",children:"main branch"}),", it'll give you clarity on what's been committed into the source code. Therefore, find out about new features, fixes, improvements, etc by looking directly into the repository history."]}),"\n",(0,i.jsx)(n.h3,{id:"switch-to-installer-username",children:"Switch to installer username"}),"\n",(0,i.jsx)(n.p,{children:"First, switch to the username you've used to install and setup Fleek Network Lightning."}),"\n",(0,i.jsx)(n.p,{children:"To switch to the username you've used throughout the installation process do:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su \n"})}),"\n",(0,i.jsxs)(n.p,{children:["For example, if you used the username ",(0,i.jsx)(n.code,{children:"lgtn"})," it'll look like the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,i.jsx)(n.h3,{id:"change-directory-to-the-source-code",children:"Change directory to the source code"}),"\n",(0,i.jsxs)(n.p,{children:["Next, ",(0,i.jsx)(n.code,{children:"change directory"})," to the Lightning directory in your file system."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The tild ",(0,i.jsx)(n.code,{children:"~"})," means user $HOME, thus you have to be logged in with the correct user as requested in the ",(0,i.jsx)(n.a,{href:"#switch-to-installer-username",children:"installer username"})," step."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd \n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have installed it via the recommended instructions, then the default location where the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"source code"})," is stored should be ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),". Otherwise, if you opted-in for a custom location then look into your notes before proceeding."]}),"\n",(0,i.jsx)(n.p,{children:"For example, it'd look like the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsx)(n.h3,{id:"checkout-to-branch",children:"Checkout to branch"}),"\n",(0,i.jsxs)(n.p,{children:["Make sure that you are checked in to the correct branch. For example, if that'd be the first testnet phase it'd be called ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout \n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of how the command would look like for the main default branch with corresponding name ",(0,i.jsx)(n.code,{children:"main"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout main\n"})}),"\n",(0,i.jsx)(a,{}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of how the command would look like for the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout testnet-alpha-1\n"})}),"\n",(0,i.jsx)(n.h3,{id:"pull-the-latest-changes",children:"Pull the latest changes"}),"\n",(0,i.jsx)(n.p,{children:"The syntax to pull the latest commits is the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git pull \n"})}),"\n",(0,i.jsxs)(n.p,{children:["The git pull command is used to fetch and merge changes from the remote repository to the local repository. Here we're pulling from remote named ",(0,i.jsx)(n.code,{children:"origin"})," and branch ",(0,i.jsx)(n.code,{children:"main"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git pull origin main\n"})}),"\n",(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsxs)(n.p,{children:["If you've made any changes in the local repository directory, clear them to prevent being blocked. As ",(0,i.jsx)(n.code,{children:"git"})," is a ",(0,i.jsx)(n.code,{children:"version control"})," program that looks for changes and will ask you to do something about it to prevent losing data. Most readers can disregard changes if not contributing to the development by simply ",(0,i.jsx)(n.a,{href:"https://git-scm.com/docs/git-stash",children:"stashing"})," or resetting the changes."]}),(0,i.jsxs)(n.p,{children:["A quick way to clean is to ",(0,i.jsx)(n.code,{children:"stash"})," the changes, for example:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git stash \n"})})]}),"\n",(0,i.jsx)(n.p,{children:"You can check yourself, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git remote -v\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Our output clearly describes what ",(0,i.jsx)(n.code,{children:"origin"})," is tracking."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"origin\tgit@github.com:fleek-network/lightning.git (fetch)\norigin\tgit@github.com:fleek-network/lightning.git (push)\n"})}),"\n",(0,i.jsx)(n.p,{children:"Alternatively, you can stash and pull, to reset the repository to the origin."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git fetch origin \ngit reset --hard origin/\ngit clean -f\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["With ",(0,i.jsx)(n.code,{children:"git"})," you can point to any point in the repository history, there might be lots of reasons you'd want to check into a certain commit or branch, e.g. if you encounter bugs and need to revert to a previous commit or version. That being said, we welcome all kinds of contributions, such as simply reporting bugs. To report issues in our repository visit the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/issues",children:"issues"})," page to help us improve."]})}),"\n",(0,i.jsx)(n.p,{children:"Here's the output we got after the git pull:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"remote: Enumerating objects: 437, done.\nremote: Counting objects: 100% (437/437), done.\nremote: Compressing objects: 100% (205/205), done.\nremote: Total 397 (delta 242), reused 334 (delta 181), pack-reused 0\nReceiving objects: 100% (397/397), 214.68 KiB | 4.77 MiB/s, done.\nResolving deltas: 100% (242/242), completed with 29 local objects.\nFrom https://github.com/fleek-network/lightning\n * branch main -> FETCH_HEAD\n 12b2647..998108d main -> origin/main\nUpdating 12b2647..998108d\nFast-forward\n .dockerignore | 6 -\n .gitignore | 2 +\n Cargo.lock | 782 +++++++----------------\n Cargo.toml | 2 +-\n core/application/src/state.rs | 12 +-\n core/cli/Cargo.toml | 47 ++\n core/cli/readme.md | 59 ++\n core/cli/src/args.rs | 63 ++\n core/cli/src/cli.rs | 136 ++++\n core/cli/src/commands/dev.rs | 112 ++++\n core/cli/src/commands/key.rs | 92 +++\n\n ...\n"})}),"\n",(0,i.jsx)(n.p,{children:"When your local version of the repository, is up-to-date with the remote repository, you'd get:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"From https://github.com/fleek-network/lightning\n * branch main -> FETCH_HEAD\nAlready up to date.\n"})}),"\n",(0,i.jsxs)(n.p,{children:['A "already up to date" message means that you have the latest version of the source code and can proceed with compiling the binary process from the source code to override the ',(0,i.jsx)(n.code,{children:"Lightning CLI"})," version you're on. You can also make any other setup changes that might find necessary. Some changes might be related to the recommended setup of Systemd Service that helps control the Fleek Network Lightning Node binary process, etc."]}),"\n",(0,i.jsx)(n.h2,{id:"build-the-binary-from-the-source-code",children:"Build the binary from the source code"}),"\n",(0,i.jsxs)(n.p,{children:["We're assuming that your system setup hasn't changed, such as Rust toolchain still being installed and setup correctly in the system and any other required dependencies. If you have made changes to your system and need to revisit the setup instructions, check our install document ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"here"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["First, switch the user and change directory to the Lightning directory in your file system as described in ",(0,i.jsx)(n.a,{href:"#switch-to-installer-username",children:"switch to installer username"})," ",(0,i.jsx)(n.a,{href:"#change-directory-to-the-source-code",children:"change directory to the source code"})," sections."]}),"\n",(0,i.jsx)(n.p,{children:"Recall the command from our install document or getting started guide? As you probably guessed, you need to execute the rust cargo build command. But firstly, we are going to clean and update the Rust package manager, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo clean\ncargo update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, execute the build command to compile the Fleek Network Lightning CLI binary."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The build command uses the Rust compiler, which might take a while depending on how speedy the host machine is capable."})}),"\n",(0,i.jsx)(n.p,{children:"Once the Rust compiler completes, the generated binary will be available in the source code project directory."}),"\n",(0,i.jsxs)(n.p,{children:["If you have stick with the default recommendation, that'll be at ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"checkup-the-symlink-setup",children:"Checkup the symlink setup"}),"\n",(0,i.jsxs)(n.p,{children:["During the original install and setup process, a symbolic link (symlink) was created linking the generated binary file located in ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"})," to ",(0,i.jsx)(n.code,{children:"/usr/local/bin/lgtn"}),". By placing the symlink in the the default installation location of the user, the executable application is available globally as ",(0,i.jsx)(n.code,{children:"lgtn"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"You can see the full absolute path of the symlink and verify if setup correctly by running:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"readlink -f \n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have followed the recommended name, the symbolic link should be called ",(0,i.jsx)(n.code,{children:"lgtn"}),", short version for ",(0,i.jsx)(n.code,{children:"lightning"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"readlink -f lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example where we find the symlink ",(0,i.jsx)(n.code,{children:"lgtn"})," pointing to the absolute path where our source code and originated built binary is located, as described in the ",(0,i.jsx)(n.a,{href:"#build-the-binary-from-the-source-code",children:"build the binary from the source code"})," section."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home//fleek-network/lightning/target/release/lightning-node\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, you can use the ",(0,i.jsx)(n.code,{children:"ls"})," command to identify the symlink."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"ls -la $(which lgtn)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you find an error, it's very likely that a symlink is not setup. You can revisit the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"installation"})," to learn, or execute the command to link the build binary to the user default install location:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "~/fleek-network/lightning/target/release/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Make sure that the paths provided to the command ",(0,i.jsx)(n.code,{children:"ln"})," are correct. If you are using customized pathnames or switched to a different username other than the one used for installation it has to change accordingly."]})}),"\n",(0,i.jsx)(n.h2,{id:"systemd-service",children:"Systemd service"}),"\n",(0,i.jsx)(n.p,{children:"It's highly recommended to use systemd to manage the Fleek Network service for node operators. Systemd is a system and service manager for Linux operating systems that provides a consistent way to manage system services across various distributions."}),"\n",(0,i.jsx)(n.h3,{id:"verify-the-setup",children:"Verify the setup"}),"\n",(0,i.jsxs)(n.p,{children:["The recommended setup is to wrap the Lightning binary process as a Systemd service, as instructed in the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install"})," section."]}),"\n",(0,i.jsxs)(n.p,{children:["If you have followed the recommendations, you should have the service file called ",(0,i.jsx)(n.code,{children:"ligthning.service"})," in the path ",(0,i.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["The content of ",(0,i.jsx)(n.code,{children:"lightning.service"})," should have some or more of the following properties and values:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml -vv run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,i.jsx)(n.p,{children:"Every time the file is modified, the Systemd process should be reloaded. You can do this by executing:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about how to create a Systemd service read the ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document that illustrates the steps required in greater detail."]}),"\n",(0,i.jsx)(n.h3,{id:"launching-the-node-as-a-systemd-service",children:"Launching the node as a systemd service"}),"\n",(0,i.jsx)(n.p,{children:"After completing all the steps and checkups mentioned throughout the guide, you should have the Fleek Network Lightning Service ready to go."}),"\n",(0,i.jsx)(n.p,{children:"To launch the service, execute the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about how to use Systemctl to manage the Lightning service, read the document ",(0,i.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"health-check",children:"Health check"}),"\n",(0,i.jsx)(n.p,{children:"First, complete all the steps and checkups mentioned throught the guide and once the Node process is running perform a health check."}),"\n",(0,i.jsxs)(n.p,{children:["To run a quick health checkup, send a GET request to ",(0,i.jsx)(n.code,{children:"/health"})," endpoint of the RPC on ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#ports",children:"port"})," 4230."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,i.jsxs)(n.p,{children:["If successful, you should get the response ",(0,i.jsx)(n.code,{children:"running and staked"}),", as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"running and staked\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you'd like to learn more about health check, visit the section ",(0,i.jsx)(n.a,{href:"/docs/node/health-check",children:"health check"})," of our documentation."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network's Ursa CLI is in constant development, there are frequent changes that can introduce features, fixes, and performance improvements, but also breaking changes that in some cases require you to add, including new libraries or packages in your operating system."}),"\n",(0,i.jsx)(n.p,{children:"In the current phase of development, a proper software release cycle for the updates is still in development, thus we pick changes from the source repository to build the Lightning application."}),"\n",(0,i.jsx)(n.p,{children:"We have looked into how to pull the changes via Git, and discussed that contributions can introduce new requirements to the host operating system that leads to updates or changes in the documentation\u2013mentioning how hard it is to keep in sync. Explained how to look into the contributions to understand the nature of the change and get hints about new features."}),"\n",(0,i.jsx)(n.p,{children:"To complete, provided a step-by-step walkthrough the installation and setup process for the Fleek Network Lightning CLI and Systemd service."}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,i.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:o,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1506:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/updating-lightning-e5c2633345bdcc0db715dd87b269b25b.png"},2913:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/updating-lightning-e5c2633345bdcc0db715dd87b269b25b.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9829],{7631:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>h,toc:()=>u});var i=t(5893),s=t(1151),o=t(3872);function r(e){const n={a:"a",admonition:"admonition",p:"p",...(0,s.a)(),...e.components};return(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsxs)(n.p,{children:["During testnet phase, you have to checkout to the testnet branch. For example, the first testnet branch name was ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/tree/testnet-alpha-1",children:"testnet-alpha-1"})," that you would have to be checked in order to run a node successfully. A list of the active branches can be found at anytime in the GitHub repository ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/branches",children:"active branches"}),". While we try our best to update documentation, guides, instructions or any other written content during development, there might be breaking changes that might take some time to reflect in our documents. To avoid disappointment, check into the correct branch or contribute by getting in touch with us, or sending a PR in the relevant context, thank you!"]})})}function a(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(r,{...e})}):r(e)}const l={title:"Updating Lightning",hide_title:!0,slug:"updating-lightning",date:new Date("2023-09-19T12:00:00.000Z"),image:"./assets/updating-lightning.png?202309191740",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",category:"Tutorial",tags:["update","rebuild","guide","setup","configuration"]},c=void 0,h={id:"Node Operators/updating-lightning",title:"Updating Lightning",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",source:"@site/guides/Node Operators/updating-lightning.md",sourceDirName:"Node Operators",slug:"/Node Operators/updating-lightning",permalink:"/guides/Node Operators/updating-lightning",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/guides/Node Operators/updating-lightning.md",tags:[{label:"update",permalink:"/guides/tags/update"},{label:"rebuild",permalink:"/guides/tags/rebuild"},{label:"guide",permalink:"/guides/tags/guide"},{label:"setup",permalink:"/guides/tags/setup"},{label:"configuration",permalink:"/guides/tags/configuration"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Updating Lightning",hide_title:!0,slug:"updating-lightning",date:"2023-09-19T12:00:00.000Z",image:"./assets/updating-lightning.png?202309191740",description:"A step-by-step guide to update the Lightning CLI from source code and Service setup",category:"Tutorial",tags:["update","rebuild","guide","setup","configuration"]},sidebar:"defaultSidebar",previous:{title:"Transfering setup ownership",permalink:"/guides/Node Operators/transfering-setup-ownership"}},d={image:t(1506).Z},u=[{value:"Introduction",id:"introduction",level:2},{value:"Pre-requisites",id:"pre-requisites",level:2},{value:"Pulling the latest changes",id:"pulling-the-latest-changes",level:2},{value:"Switch to installer username",id:"switch-to-installer-username",level:3},{value:"Change directory to the source code",id:"change-directory-to-the-source-code",level:3},{value:"Checkout to branch",id:"checkout-to-branch",level:3},{value:"Pull the latest changes",id:"pull-the-latest-changes",level:3},{value:"Build the binary from the source code",id:"build-the-binary-from-the-source-code",level:2},{value:"Checkup the symlink setup",id:"checkup-the-symlink-setup",level:2},{value:"Systemd service",id:"systemd-service",level:2},{value:"Verify the setup",id:"verify-the-setup",level:3},{value:"Launching the node as a systemd service",id:"launching-the-node-as-a-systemd-service",level:3},{value:"Health check",id:"health-check",level:2},{value:"Conclusion",id:"conclusion",level:2}];function g(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"Update Lightning",src:t(2913).Z+"",width:"1450",height:"816"})}),"\n","\n","\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Fleek Network's Lightning source code is updated frequently and thus keeping up with changes can be a bit of a chore and especially difficult for users who are trying to have it compiled for the first time, or updating the Lightning CLI binary for their operating systems. While we should have stable releases in the future, at the current phase of development, there's a requirement to follow the contributions directly in the repository: checking in and out, the commits you're interested in running."}),"\n",(0,i.jsxs)(n.p,{children:["In the following guide, we\u2019ll have a simple look into how to pull changes and update Lightning CLI on Linux, which we stick with Ubuntu for simplicity but should be easily transferrable to your ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#server",children:"supported OS"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"pre-requisites",children:"Pre-requisites"}),"\n",(0,i.jsx)(n.p,{children:"To follow the guide, you will need the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Familiarity with the command-line interface"}),"\n",(0,i.jsx)(n.li,{children:"Some experience with Git"}),"\n",(0,i.jsx)(n.li,{children:"Have installed and set up the Lightning CLI and service"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"pulling-the-latest-changes",children:"Pulling the latest changes"}),"\n",(0,i.jsxs)(n.p,{children:["Check the latest contributions pushed to the Lightning CLI ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/commits/main",children:"main branch"}),", it'll give you clarity on what's been committed into the source code. Therefore, find out about new features, fixes, improvements, etc by looking directly into the repository history."]}),"\n",(0,i.jsx)(n.h3,{id:"switch-to-installer-username",children:"Switch to installer username"}),"\n",(0,i.jsx)(n.p,{children:"First, switch to the username you've used to install and setup Fleek Network Lightning."}),"\n",(0,i.jsx)(n.p,{children:"To switch to the username you've used throughout the installation process do:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su \n"})}),"\n",(0,i.jsxs)(n.p,{children:["For example, if you used the username ",(0,i.jsx)(n.code,{children:"lgtn"})," it'll look like the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"su lgtn\n"})}),"\n",(0,i.jsx)(n.h3,{id:"change-directory-to-the-source-code",children:"Change directory to the source code"}),"\n",(0,i.jsxs)(n.p,{children:["Next, ",(0,i.jsx)(n.code,{children:"change directory"})," to the Lightning directory in your file system."]}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["The tild ",(0,i.jsx)(n.code,{children:"~"})," means user $HOME, thus you have to be logged in with the correct user as requested in the ",(0,i.jsx)(n.a,{href:"#switch-to-installer-username",children:"installer username"})," step."]})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd \n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have installed it via the recommended instructions, then the default location where the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"source code"})," is stored should be ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning"}),". Otherwise, if you opted-in for a custom location then look into your notes before proceeding."]}),"\n",(0,i.jsx)(n.p,{children:"For example, it'd look like the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,i.jsx)(n.h3,{id:"checkout-to-branch",children:"Checkout to branch"}),"\n",(0,i.jsxs)(n.p,{children:["Make sure that you are checked in to the correct branch. For example, if that'd be the first testnet phase it'd be called ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout \n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of how the command would look like for the main default branch with corresponding name ",(0,i.jsx)(n.code,{children:"main"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout main\n"})}),"\n",(0,i.jsx)(a,{}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example of how the command would look like for the branch name ",(0,i.jsx)(n.code,{children:"testnet-alpha-1"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git checkout testnet-alpha-1\n"})}),"\n",(0,i.jsx)(n.h3,{id:"pull-the-latest-changes",children:"Pull the latest changes"}),"\n",(0,i.jsx)(n.p,{children:"The syntax to pull the latest commits is the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git pull \n"})}),"\n",(0,i.jsxs)(n.p,{children:["The git pull command is used to fetch and merge changes from the remote repository to the local repository. Here we're pulling from remote named ",(0,i.jsx)(n.code,{children:"origin"})," and branch ",(0,i.jsx)(n.code,{children:"main"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git pull origin main\n"})}),"\n",(0,i.jsxs)(n.admonition,{type:"tip",children:[(0,i.jsxs)(n.p,{children:["If you've made any changes in the local repository directory, clear them to prevent being blocked. As ",(0,i.jsx)(n.code,{children:"git"})," is a ",(0,i.jsx)(n.code,{children:"version control"})," program that looks for changes and will ask you to do something about it to prevent losing data. Most readers can disregard changes if not contributing to the development by simply ",(0,i.jsx)(n.a,{href:"https://git-scm.com/docs/git-stash",children:"stashing"})," or resetting the changes."]}),(0,i.jsxs)(n.p,{children:["A quick way to clean is to ",(0,i.jsx)(n.code,{children:"stash"})," the changes, for example:"]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git stash \n"})})]}),"\n",(0,i.jsx)(n.p,{children:"You can check yourself, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git remote -v\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Our output clearly describes what ",(0,i.jsx)(n.code,{children:"origin"})," is tracking."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"origin\tgit@github.com:fleek-network/lightning.git (fetch)\norigin\tgit@github.com:fleek-network/lightning.git (push)\n"})}),"\n",(0,i.jsx)(n.p,{children:"Alternatively, you can stash and pull, to reset the repository to the origin."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"git fetch origin \ngit reset --hard origin/\ngit clean -f\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["With ",(0,i.jsx)(n.code,{children:"git"})," you can point to any point in the repository history, there might be lots of reasons you'd want to check into a certain commit or branch, e.g. if you encounter bugs and need to revert to a previous commit or version. That being said, we welcome all kinds of contributions, such as simply reporting bugs. To report issues in our repository visit the ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/issues",children:"issues"})," page to help us improve."]})}),"\n",(0,i.jsx)(n.p,{children:"Here's the output we got after the git pull:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"remote: Enumerating objects: 437, done.\nremote: Counting objects: 100% (437/437), done.\nremote: Compressing objects: 100% (205/205), done.\nremote: Total 397 (delta 242), reused 334 (delta 181), pack-reused 0\nReceiving objects: 100% (397/397), 214.68 KiB | 4.77 MiB/s, done.\nResolving deltas: 100% (242/242), completed with 29 local objects.\nFrom https://github.com/fleek-network/lightning\n * branch main -> FETCH_HEAD\n 12b2647..998108d main -> origin/main\nUpdating 12b2647..998108d\nFast-forward\n .dockerignore | 6 -\n .gitignore | 2 +\n Cargo.lock | 782 +++++++----------------\n Cargo.toml | 2 +-\n core/application/src/state.rs | 12 +-\n core/cli/Cargo.toml | 47 ++\n core/cli/readme.md | 59 ++\n core/cli/src/args.rs | 63 ++\n core/cli/src/cli.rs | 136 ++++\n core/cli/src/commands/dev.rs | 112 ++++\n core/cli/src/commands/key.rs | 92 +++\n\n ...\n"})}),"\n",(0,i.jsx)(n.p,{children:"When your local version of the repository, is up-to-date with the remote repository, you'd get:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"From https://github.com/fleek-network/lightning\n * branch main -> FETCH_HEAD\nAlready up to date.\n"})}),"\n",(0,i.jsxs)(n.p,{children:['A "already up to date" message means that you have the latest version of the source code and can proceed with compiling the binary process from the source code to override the ',(0,i.jsx)(n.code,{children:"Lightning CLI"})," version you're on. You can also make any other setup changes that might find necessary. Some changes might be related to the recommended setup of Systemd Service that helps control the Fleek Network Lightning Node binary process, etc."]}),"\n",(0,i.jsx)(n.h2,{id:"build-the-binary-from-the-source-code",children:"Build the binary from the source code"}),"\n",(0,i.jsxs)(n.p,{children:["We're assuming that your system setup hasn't changed, such as Rust toolchain still being installed and setup correctly in the system and any other required dependencies. If you have made changes to your system and need to revisit the setup instructions, check our install document ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"here"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["First, switch the user and change directory to the Lightning directory in your file system as described in ",(0,i.jsx)(n.a,{href:"#switch-to-installer-username",children:"switch to installer username"})," ",(0,i.jsx)(n.a,{href:"#change-directory-to-the-source-code",children:"change directory to the source code"})," sections."]}),"\n",(0,i.jsx)(n.p,{children:"Recall the command from our install document or getting started guide? As you probably guessed, you need to execute the rust cargo build command. But firstly, we are going to clean and update the Rust package manager, as follows:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo clean\ncargo update\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, execute the build command to compile the Fleek Network Lightning CLI binary."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"cargo +stable build --release\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsx)(n.p,{children:"The build command uses the Rust compiler, which might take a while depending on how speedy the host machine is capable."})}),"\n",(0,i.jsx)(n.p,{children:"Once the Rust compiler completes, the generated binary will be available in the source code project directory."}),"\n",(0,i.jsxs)(n.p,{children:["If you have stick with the default recommendation, that'll be at ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"checkup-the-symlink-setup",children:"Checkup the symlink setup"}),"\n",(0,i.jsxs)(n.p,{children:["During the original install and setup process, a symbolic link (symlink) was created linking the generated binary file located in ",(0,i.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"})," to ",(0,i.jsx)(n.code,{children:"/usr/local/bin/lgtn"}),". By placing the symlink in the the default installation location of the user, the executable application is available globally as ",(0,i.jsx)(n.code,{children:"lgtn"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"You can see the full absolute path of the symlink and verify if setup correctly by running:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"readlink -f \n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have followed the recommended name, the symbolic link should be called ",(0,i.jsx)(n.code,{children:"lgtn"}),", short version for ",(0,i.jsx)(n.code,{children:"lightning"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"readlink -f lgtn\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Here's an example where we find the symlink ",(0,i.jsx)(n.code,{children:"lgtn"})," pointing to the absolute path where our source code and originated built binary is located, as described in the ",(0,i.jsx)(n.a,{href:"#build-the-binary-from-the-source-code",children:"build the binary from the source code"})," section."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"/home//fleek-network/lightning/target/release/lightning-node\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, you can use the ",(0,i.jsx)(n.code,{children:"ls"})," command to identify the symlink."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"ls -la $(which lgtn)\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you find an error, it's very likely that a symlink is not setup. You can revisit the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"installation"})," to learn, or execute the command to link the build binary to the user default install location:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'sudo ln -s "~/fleek-network/lightning/target/release/lightning-node" /usr/local/bin/lgtn\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["Make sure that the paths provided to the command ",(0,i.jsx)(n.code,{children:"ln"})," are correct. If you are using customized pathnames or switched to a different username other than the one used for installation it has to change accordingly."]})}),"\n",(0,i.jsx)(n.h2,{id:"systemd-service",children:"Systemd service"}),"\n",(0,i.jsx)(n.p,{children:"It's highly recommended to use systemd to manage the Fleek Network service for node operators. Systemd is a system and service manager for Linux operating systems that provides a consistent way to manage system services across various distributions."}),"\n",(0,i.jsx)(n.h3,{id:"verify-the-setup",children:"Verify the setup"}),"\n",(0,i.jsxs)(n.p,{children:["The recommended setup is to wrap the Lightning binary process as a Systemd service, as instructed in the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install"})," section."]}),"\n",(0,i.jsxs)(n.p,{children:["If you have followed the recommendations, you should have the service file called ",(0,i.jsx)(n.code,{children:"ligthning.service"})," in the path ",(0,i.jsx)(n.code,{children:"/etc/systemd/system/lightning.service"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["The content of ",(0,i.jsx)(n.code,{children:"lightning.service"})," should have some or more of the following properties and values:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"[Unit]\nDescription=Fleek Network Node lightning service\n\n[Service]\nType=simple\nMemoryHigh=32G\nRestartSec=15s\nRestart=always\nExecStart=lgtn -c /home/lgtn/.lightning/config.toml -vv run\nStandardOutput=append:/var/log/lightning/output.log\nStandardError=append:/var/log/lightning/diagnostic.log\nEnvironment=TMPDIR=/var/tmp\n\n[Install]\nWantedBy=multi-user.target\n"})}),"\n",(0,i.jsx)(n.p,{children:"Every time the file is modified, the Systemd process should be reloaded. You can do this by executing:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about how to create a Systemd service read the ",(0,i.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation"})," document that illustrates the steps required in greater detail."]}),"\n",(0,i.jsx)(n.h3,{id:"launching-the-node-as-a-systemd-service",children:"Launching the node as a systemd service"}),"\n",(0,i.jsx)(n.p,{children:"After completing all the steps and checkups mentioned throughout the guide, you should have the Fleek Network Lightning Service ready to go."}),"\n",(0,i.jsx)(n.p,{children:"To launch the service, execute the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["To learn more about how to use Systemctl to manage the Lightning service, read the document ",(0,i.jsx)(n.a,{href:"/docs/node/install#use-systemctl-to-manage-systemd-service",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"health-check",children:"Health check"}),"\n",(0,i.jsx)(n.p,{children:"First, complete all the steps and checkups mentioned throught the guide and once the Node process is running perform a health check."}),"\n",(0,i.jsxs)(n.p,{children:["To run a quick health checkup, send a GET request to ",(0,i.jsx)(n.code,{children:"/health"})," endpoint of the RPC on ",(0,i.jsx)(n.a,{href:"/docs/node/requirements#ports",children:"port"})," 4230."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,i.jsxs)(n.p,{children:["If successful, you should get the response ",(0,i.jsx)(n.code,{children:"running and staked"}),", as follows:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"running and staked\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you'd like to learn more about health check, visit the section ",(0,i.jsx)(n.a,{href:"/docs/node/health-check",children:"health check"})," of our documentation."]}),"\n",(0,i.jsx)(n.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network's Ursa CLI is in constant development, there are frequent changes that can introduce features, fixes, and performance improvements, but also breaking changes that in some cases require you to add, including new libraries or packages in your operating system."}),"\n",(0,i.jsx)(n.p,{children:"In the current phase of development, a proper software release cycle for the updates is still in development, thus we pick changes from the source repository to build the Lightning application."}),"\n",(0,i.jsx)(n.p,{children:"We have looked into how to pull the changes via Git, and discussed that contributions can introduce new requirements to the host operating system that leads to updates or changes in the documentation\u2013mentioning how hard it is to keep in sync. Explained how to look into the contributions to understand the nature of the change and get hints about new features."}),"\n",(0,i.jsx)(n.p,{children:"To complete, provided a step-by-step walkthrough the installation and setup process for the Fleek Network Lightning CLI and Systemd service."}),"\n",(0,i.jsxs)(n.p,{children:["Discover more about the project by ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"watching/contributing on GitHub"}),", following us on ",(0,i.jsx)(n.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", and joining ",(0,i.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"our community Discord"})," for any updates."]}),"\n",(0,i.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:o,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:o,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1506:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/updating-lightning-e5c2633345bdcc0db715dd87b269b25b.png"},2913:(e,n,t)=>{t.d(n,{Z:()=>i});const i=t.p+"assets/images/updating-lightning-e5c2633345bdcc0db715dd87b269b25b.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/665f164c.bbb4b5f5.js b/assets/js/665f164c.bbb4b5f5.js new file mode 100644 index 000000000..064492212 --- /dev/null +++ b/assets/js/665f164c.bbb4b5f5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9320],{3566:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>h});var s=n(5893),o=n(1151),i=n(3872);const r={title:"Testnet onboarding",slug:"testnet-onboarding",hide_title:!0,description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",tags:["testnet","onboarding","phases","getting started"],sidebarCollapsible:!1},a=void 0,l={id:"node/testnet-onboarding",title:"Testnet onboarding",description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",source:"@site/docs/node/testnet-onboarding.md",sourceDirName:"node",slug:"/node/testnet-onboarding",permalink:"/docs/node/testnet-onboarding",draft:!1,unlisted:!1,tags:[{label:"testnet",permalink:"/docs/tags/testnet"},{label:"onboarding",permalink:"/docs/tags/onboarding"},{label:"phases",permalink:"/docs/tags/phases"},{label:"getting started",permalink:"/docs/tags/getting-started"}],version:"current",frontMatter:{title:"Testnet onboarding",slug:"testnet-onboarding",hide_title:!0,description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",tags:["testnet","onboarding","phases","getting started"],sidebarCollapsible:!1},sidebar:"docs",previous:{title:"Requirements",permalink:"/docs/node/requirements"},next:{title:"Install",permalink:"/docs/node/install"}},d={},h=[{value:"Testnet Phase 1:",id:"testnet-phase-1",level:2},{value:"Prerequesites",id:"prerequesites",level:3},{value:"1) Install the Fleek Network Lightning CLI latest version",id:"1-install-the-fleek-network-lightning-cli-latest-version",level:3},{value:"2) Set up the Metamask browser extension",id:"2-set-up-the-metamask-browser-extension",level:3},{value:"3) Visit the faucet website",id:"3-visit-the-faucet-website",level:3},{value:"4) Connect wallet",id:"4-connect-wallet",level:3},{value:"5) Mint tFLK",id:"5-mint-tflk",level:3},{value:"6) Stake tFLK",id:"6-stake-tflk",level:3},{value:"7) Confirm the transaction on metamask",id:"7-confirm-the-transaction-on-metamask",level:3},{value:"8) Start the Node",id:"8-start-the-node",level:3},{value:"9) Confirm Node Stake",id:"9-confirm-node-stake",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"The Node fails to run after successfully stake and run? Or the Core team network restart announcement?",id:"the-node-fails-to-run-after-successfully-stake-and-run-or-the-core-team-network-restart-announcement",level:3},{value:"Node details don't show staked amount?",id:"node-details-dont-show-staked-amount",level:3},{value:"Can I shut down the node after Testnet completion?",id:"can-i-shut-down-the-node-after-testnet-completion",level:3}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.admonition,{title:"Important",type:"info",children:(0,s.jsxs)(t.p,{children:["The ",(0,s.jsxs)(t.strong,{children:["Testnet Phase ",1," has finished"]})," on Thursday, Oct. 26th. Phase ",1," turned out to be an enormous success. Seeing 5k+ nodes successfully running across the network and demonstrating that Fleek Network is capable of being just as performant as web2 cdn/edge platforms and, with further optimizations, potentially even more performant. Dive into the full performance data and key analysis in the Phase ",1," recap ",(0,s.jsx)(t.a,{href:"https://blog.fleek.network/post/fleek-network-phase-1-recap",children:"blog"}),". If you'd like to ",(0,s.jsx)(t.strong,{children:"participate"})," in the ",(0,s.jsxs)(t.strong,{children:["Testnet Phase ",2]}),", follow us on ",(0,s.jsx)(t.a,{href:"https://discord.gg/fleekxyz",children:"Discord"}),", ",(0,s.jsx)(t.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", or our ",(0,s.jsx)(t.a,{href:"https://blog.fleek.network/",children:"blog posts"}),"."]})}),"\n",(0,s.jsxs)(t.h2,{id:"testnet-phase-1",children:["Testnet Phase ",1,":"]}),"\n",(0,s.jsxs)(t.p,{children:["Following the successful completion of Fleek Network Testnet Phase ",0,", the core development team has been actively implementing the next set of core protocol functionalities, which include services, the reward's system, the broadcaster/synchronizer, as well as all identified improvements and fixes found during that phase."]}),"\n",(0,s.jsx)(t.h3,{id:"prerequesites",children:"Prerequesites"}),"\n",(0,s.jsxs)(t.p,{children:["The Testnet Phase ",1," is open to everybody. Everyone's free to join the Testnet Phase ",1,", regardless of whether they have participated in any prior testnet phase, filled any forms or whitelisting."]}),"\n",(0,s.jsxs)(t.p,{children:["The Fleek team cares about user experience and provides documentation and tools (whichever's your preference) to onboard easily and quickly. However, the Node operator's server should have the ",(0,s.jsx)(t.a,{href:"/docs/node/requirements",children:"minimum requirements"})," to set up and run a Fleek Network node."]}),"\n",(0,s.jsx)(t.p,{children:"To join, you will have to follow the steps below:"}),"\n",(0,s.jsx)(t.h3,{id:"1-install-the-fleek-network-lightning-cli-latest-version",children:"1) Install the Fleek Network Lightning CLI latest version"}),"\n",(0,s.jsxs)(t.p,{children:["Once Fleek launches the Testnet Phase ",1,", you have to install or update the Lightning CLI binary to the latest version. The instructions are available ",(0,s.jsx)(t.a,{href:"/docs/node/install",children:"here"})," where you can use an assisted installer or install it manually by following the documentation. If you already have it installed, use the update reference provided ",(0,s.jsx)(t.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code",children:"here"})," or if you prefer a more step-by-step approach use the provided ",(0,s.jsx)(t.a,{href:"/guides/Node%20Operators/updating-lightning",children:"guide"}),"."]}),"\n",(0,s.jsx)(t.admonition,{title:"Warning",type:"caution",children:(0,s.jsxs)(t.p,{children:["The Testnet Phase ",1," version should only be available after the Testnet Phase ",1," is ready and announced. Since we work transparently (open-source) some users rush to install things on their own assumptions, misaligned, which causes them confusion. The Fleek Network core team is required to provide all the changes, features and tests before announcing publicly that the testnet phase is ready. Otherwise, you'll be running the process prematurely, be patient to avoid disappointment please!"]})}),"\n",(0,s.jsx)(t.h3,{id:"2-set-up-the-metamask-browser-extension",children:"2) Set up the Metamask browser extension"}),"\n",(0,s.jsxs)(t.p,{children:["Open the Metamask ",(0,s.jsx)(t.code,{children:"settings"}),", located in the drop-down (top-right menu options). Set the following property values:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["Network Name: ",(0,s.jsx)(t.code,{children:"Fleek Network Testnet"})]}),"\n",(0,s.jsxs)(t.li,{children:["RPC URL: ",(0,s.jsx)(t.code,{children:"https://rpc.testnet.fleek.network/rpc/v0"})]}),"\n",(0,s.jsxs)(t.li,{children:["Chain ID: ",(0,s.jsx)(t.code,{children:"59330"})]}),"\n",(0,s.jsxs)(t.li,{children:["Currency symbol: ",(0,s.jsx)(t.code,{children:"tFLK"})]}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"note",children:(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Testnet FLK"})," on testnets are supposed to have no real value. Since you need Testnet ",(0,s.jsx)(t.code,{children:"FLK"})," to actually interact with Fleek Network, users get ",(0,s.jsx)(t.code,{children:"Testnet FLK"})," for free from the faucet. For clarity and simplicity we'll refer to ",(0,s.jsx)(t.code,{children:"Testnet FLK"})," as ",(0,s.jsx)(t.code,{children:"tFLK"}),"."]})}),"\n",(0,s.jsx)(t.h3,{id:"3-visit-the-faucet-website",children:"3) Visit the faucet website"}),"\n",(0,s.jsxs)(t.p,{children:["Before proceeding, make sure to have the Fleek Network selected as the metamask network. Once confirmed, visit the ",(0,s.jsx)(t.a,{href:"https://faucet.testnet.fleek.network/",children:"Faucet website"})]}),"\n",(0,s.jsx)(t.h3,{id:"4-connect-wallet",children:"4) Connect wallet"}),"\n",(0,s.jsxs)(t.p,{children:["In the ",(0,s.jsx)(t.a,{href:"https://faucet.testnet.fleek.network/",children:"Faucet website"}),", you have to click the ",(0,s.jsx)(t.code,{children:"Connect Wallet"}),"."]}),"\n",(0,s.jsx)(t.h3,{id:"5-mint-tflk",children:"5) Mint tFLK"}),"\n",(0,s.jsxs)(t.p,{children:["Once ",(0,s.jsx)(t.code,{children:"Connect Wallet"})," is ready, proceed to ",(0,s.jsx)(t.code,{children:"Mint tFLK"})," and wait until the balance of the account in your Metamask increases. You need to have ",(0,s.jsx)(t.code,{children:"tFLK"})," before proceeding. Be patient."]}),"\n",(0,s.jsx)(t.h3,{id:"6-stake-tflk",children:"6) Stake tFLK"}),"\n",(0,s.jsxs)(t.p,{children:["Once ",(0,s.jsx)(t.code,{children:"tFLK"})," balance is available, click in the ",(0,s.jsx)(t.code,{children:"Stake"})," button. You'll be required to provided the following details from your node:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Node Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Consensus Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Server IP Address"}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["You can get the details quickly by running the ",(0,s.jsx)(t.strong,{children:"node details"})," script in the terminal connected to your machine or server where the node is set up and running, as follows:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"curl https://get.fleek.network/node_details | bash\n"})}),"\n",(0,s.jsx)(t.p,{children:"The response should include the following details:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"\ud83e\udd16 Your server details are the following\n\nThe Node Public Key is \nThe Consensus Public Key is \nThe Node Server IP address is \n"})}),"\n",(0,s.jsx)(t.admonition,{title:"warning",type:"caution",children:(0,s.jsxs)(t.p,{children:["The output above is an example, you'll not find the actual text ",(0,s.jsx)(t.code,{children:""}),", ",(0,s.jsx)(t.code,{children:""})," but the text values (string of bits), or ",(0,s.jsx)(t.code,{children:""})," where instead you'll find a numerical ip address.\nMake sure that you copy and paste the correct values otherwise the transaction will fail!"]})}),"\n",(0,s.jsx)(t.h3,{id:"7-confirm-the-transaction-on-metamask",children:"7) Confirm the transaction on metamask"}),"\n",(0,s.jsx)(t.p,{children:"It is important to note that when transacting through Metamask, a warning message might pop up regarding gas costs, but rest assured that there won't be any deductions from your wallet balance."}),"\n",(0,s.jsx)(t.p,{children:"You'll have to wait for Metamask to confirm the transaction, which Metamask should take about 10 seconds to confirm. Although, the transaction takes under a second."}),"\n",(0,s.jsxs)(t.p,{children:["Important to note that in Testnet Phase ",1," the Epoch is set to about 30 minutes. This is the average period you'll have to wait to see any meaningful logs."]}),"\n",(0,s.jsx)(t.h3,{id:"8-start-the-node",children:"8) Start the Node"}),"\n",(0,s.jsxs)(t.p,{children:["Visit the section ",(0,s.jsx)(t.a,{href:"/docs/node/systemd-service",children:"Systemd Service"})," to learn how to enable, disable, start, stop the Systemd Service."]}),"\n",(0,s.jsx)(t.admonition,{type:"note",children:(0,s.jsxs)(t.p,{children:["The Systemd Service is setup automatically by the assisted installer, manually if you have followed the instructions provided, or the docker install. If you have a custom set up, you'll have to do the equivalent to start the node as described in the section ",(0,s.jsx)(t.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})}),"\n",(0,s.jsx)(t.p,{children:"Make sure you do a quick healthcheck:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"curl https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,s.jsxs)(t.p,{children:["To learn more about healchecks read the section ",(0,s.jsx)(t.a,{href:"/docs/node/health-check",children:"here"}),"."]}),"\n",(0,s.jsx)(t.h3,{id:"9-confirm-node-stake",children:"9) Confirm Node Stake"}),"\n",(0,s.jsxs)(t.p,{children:["To confirm the Node Staked amount, you can run the ",(0,s.jsx)(t.strong,{children:"node details"})," script to get the information. The ",(0,s.jsx)(t.strong,{children:"node details"})," output will only show staked information if available, if it doesn't show staked information it means that your Node is not properly staked."]}),"\n",(0,s.jsx)(t.p,{children:"Check the Node stake by running the following command in the machine or server where the node is set up:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"curl https://get.fleek.network/node_details | bash\n"})}),"\n",(0,s.jsxs)(t.p,{children:["Alternatively, the Stake amount can be verified by querying the ",(0,s.jsx)(t.a,{href:"/docs/learn/the-network/#json-rpc-interface",children:"RPC-JSON API"})," method ",(0,s.jsx)(t.code,{children:"flk_get_node_info"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsx)(t.h3,{id:"the-node-fails-to-run-after-successfully-stake-and-run-or-the-core-team-network-restart-announcement",children:"The Node fails to run after successfully stake and run? Or the Core team network restart announcement?"}),"\n",(0,s.jsxs)(t.p,{children:["The Fleek Network core team might have to restart the network, for any development purposes or required updates during the Testnet Phase ",1,". If you've done this process before and is running into issues, you'll have to go into the Metamask advance settings (Metamask \u2192 Settings \u2192 Advanced) and click ",(0,s.jsx)(t.code,{children:"Clear activity and nonce data"})," or ",(0,s.jsx)(t.code,{children:"Clear Local data"}),". After doing this Metamask will clear the cache."]}),"\n",(0,s.jsx)(t.h3,{id:"node-details-dont-show-staked-amount",children:"Node details don't show staked amount?"}),"\n",(0,s.jsxs)(t.p,{children:["If you have staked successfully and the transaction details in the Metamask wallet is confirmed, but the ",(0,s.jsx)(t.strong,{children:"node details"})," script or the ",(0,s.jsx)(t.a,{href:"/docs/learn/the-network/#json-rpc-interface",children:"RPC-JSON API"})," method ",(0,s.jsx)(t.code,{children:"flk_get_node_info"})," shows an empty result, do the following:"]}),"\n",(0,s.jsx)(t.p,{children:"Metamask:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Copy the Account address at the very top of your Metamask home"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Transaction ID by clicking in the tFLK transaction \u2192 Copy Transaction ID at the very top"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Activity log details of the transaction"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Server where the Node is set up:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Copy the Node Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Server IP Address"}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"tip",children:(0,s.jsxs)(t.p,{children:["You can get the Node Public Key and Server IP Address quick by using the ",(0,s.jsx)(t.a,{href:"#6-stake-tflk",children:"node details"})," script described in the section."]})}),"\n",(0,s.jsxs)(t.p,{children:["Report to us by sharing the details about via our ",(0,s.jsx)(t.a,{href:"https://discord.gg/fleekxyz",children:"discord"})," troubleshooting channel."]}),"\n",(0,s.jsx)(t.h3,{id:"can-i-shut-down-the-node-after-testnet-completion",children:"Can I shut down the node after Testnet completion?"}),"\n",(0,s.jsxs)(t.p,{children:["Once the Testnet finishes, it's not necessary to keep the node active. Furthermore, as the Testnet identity and its related stake hold no intrinsic value other than for testing purposes, you can delete them. Of course that if you want to learn how to back up or restore keys, you can read about how to ",(0,s.jsx)(t.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"manage the key store"})," and keep the keys."]}),"\n",(0,s.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>o});n(7294);var s=n(5893);const o=e=>{let{image:t,name:n,title:o,url:i,communityMember:r=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:n,children:(0,s.jsx)("img",{src:t,alt:n})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:n,children:n})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var s=n(7294);const o={},i=s.createContext(o);function r(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/665f164c.eea293a2.js b/assets/js/665f164c.eea293a2.js deleted file mode 100644 index 00f7454e9..000000000 --- a/assets/js/665f164c.eea293a2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[9320],{3566:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>h});var s=n(5893),o=n(1151),i=n(3872);const r={title:"Testnet onboarding",slug:"testnet-onboarding",hide_title:!0,description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",tags:["testnet","onboarding","phases","getting started"],sidebarCollapsible:!1},a=void 0,l={id:"node/testnet-onboarding",title:"Testnet onboarding",description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",source:"@site/docs/node/testnet-onboarding.md",sourceDirName:"node",slug:"/node/testnet-onboarding",permalink:"/docs/node/testnet-onboarding",draft:!1,unlisted:!1,tags:[{label:"testnet",permalink:"/docs/tags/testnet"},{label:"onboarding",permalink:"/docs/tags/onboarding"},{label:"phases",permalink:"/docs/tags/phases"},{label:"getting started",permalink:"/docs/tags/getting-started"}],version:"current",frontMatter:{title:"Testnet onboarding",slug:"testnet-onboarding",hide_title:!0,description:"Join Fleek's Testnet onboarding, follow Discord instructions to install and verify your node. Check live updates, attend community calls, and ensure node is setup correctly.",tags:["testnet","onboarding","phases","getting started"],sidebarCollapsible:!1},sidebar:"docs",previous:{title:"Requirements",permalink:"/docs/node/requirements"},next:{title:"Install",permalink:"/docs/node/install"}},d={},h=[{value:"Testnet Phase 1:",id:"testnet-phase-1",level:2},{value:"Prerequesites",id:"prerequesites",level:3},{value:"1) Install the Fleek Network Lightning CLI latest version",id:"1-install-the-fleek-network-lightning-cli-latest-version",level:3},{value:"2) Set up the Metamask browser extension",id:"2-set-up-the-metamask-browser-extension",level:3},{value:"3) Visit the faucet website",id:"3-visit-the-faucet-website",level:3},{value:"4) Connect wallet",id:"4-connect-wallet",level:3},{value:"5) Mint tFLK",id:"5-mint-tflk",level:3},{value:"6) Stake tFLK",id:"6-stake-tflk",level:3},{value:"7) Confirm the transaction on metamask",id:"7-confirm-the-transaction-on-metamask",level:3},{value:"8) Start the Node",id:"8-start-the-node",level:3},{value:"9) Confirm Node Stake",id:"9-confirm-node-stake",level:3},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"The Node fails to run after successfully stake and run? Or the Core team network restart announcement?",id:"the-node-fails-to-run-after-successfully-stake-and-run-or-the-core-team-network-restart-announcement",level:3},{value:"Node details don't show staked amount?",id:"node-details-dont-show-staked-amount",level:3}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.admonition,{title:"Important",type:"info",children:[(0,s.jsxs)(t.p,{children:["The Testnet Phase ",1," has finished on Thursday, Oct. 26th. Phase ",1," turned out to be an enormous success. Seeing 5k+ nodes successfully running across the network and demonstrating that Fleek Network is capable of being just as performant as web2 cdn/edge platforms and, with further optimizations, potentially even more performant. Dive into the full performance data and key analysis in the Phase ",1," recap ",(0,s.jsx)(t.a,{href:"https://blog.fleek.network/post/fleek-network-phase-1-recap",children:"blog"}),"."]}),(0,s.jsxs)(t.p,{children:["If you'd like to participate in the next Testnet Phase, follow us on ",(0,s.jsx)(t.a,{href:"https://discord.gg/fleekxyz",children:"Discord"}),", ",(0,s.jsx)(t.a,{href:"https://twitter.com/fleek_net",children:"Twitter"}),", or our Blog releases."]})]}),"\n",(0,s.jsxs)(t.h2,{id:"testnet-phase-1",children:["Testnet Phase ",1,":"]}),"\n",(0,s.jsxs)(t.p,{children:["Following the successful completion of Fleek Network Testnet Phase ",0,", the core development team has been actively implementing the next set of core protocol functionalities, which include services, the reward's system, the broadcaster/synchronizer, as well as all identified improvements and fixes found during that phase."]}),"\n",(0,s.jsx)(t.h3,{id:"prerequesites",children:"Prerequesites"}),"\n",(0,s.jsxs)(t.p,{children:["The Testnet Phase ",1," is open to everybody. Everyone's free to join the Testnet Phase ",1,", regardless of whether they have participated in any prior testnet phase, filled any forms or whitelisting."]}),"\n",(0,s.jsxs)(t.p,{children:["The Fleek team cares about user experience and provides documentation and tools (whichever's your preference) to onboard easily and quickly. However, the Node operator's server should have the ",(0,s.jsx)(t.a,{href:"/docs/node/requirements",children:"minimum requirements"})," to set up and run a Fleek Network node."]}),"\n",(0,s.jsx)(t.p,{children:"To join, you will have to follow the steps below:"}),"\n",(0,s.jsx)(t.h3,{id:"1-install-the-fleek-network-lightning-cli-latest-version",children:"1) Install the Fleek Network Lightning CLI latest version"}),"\n",(0,s.jsxs)(t.p,{children:["Once Fleek launches the Testnet Phase ",1,", you have to install or update the Lightning CLI binary to the latest version. The instructions are available ",(0,s.jsx)(t.a,{href:"/docs/node/install",children:"here"})," where you can use an assisted installer or install it manually by following the documentation. If you already have it installed, use the update reference provided ",(0,s.jsx)(t.a,{href:"/references/Lightning%20CLI/update-cli-from-source-code",children:"here"})," or if you prefer a more step-by-step approach use the provided ",(0,s.jsx)(t.a,{href:"/guides/Node%20Operators/updating-lightning",children:"guide"}),"."]}),"\n",(0,s.jsx)(t.admonition,{title:"Warning",type:"caution",children:(0,s.jsxs)(t.p,{children:["The Testnet Phase ",1," version should only be available after the Testnet Phase ",1," is ready and announced. Since we work transparently (open-source) some users rush to install things on their own assumptions, misaligned, which causes them confusion. The Fleek Network core team is required to provide all the changes, features and tests before announcing publicly that the testnet phase is ready. Otherwise, you'll be running the process prematurely, be patient to avoid disappointment please!"]})}),"\n",(0,s.jsx)(t.h3,{id:"2-set-up-the-metamask-browser-extension",children:"2) Set up the Metamask browser extension"}),"\n",(0,s.jsxs)(t.p,{children:["Open the Metamask ",(0,s.jsx)(t.code,{children:"settings"}),", located in the drop-down (top-right menu options). Set the following property values:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:["Network Name: ",(0,s.jsx)(t.code,{children:"Fleek Network Testnet"})]}),"\n",(0,s.jsxs)(t.li,{children:["RPC URL: ",(0,s.jsx)(t.code,{children:"https://rpc.testnet.fleek.network/rpc/v0"})]}),"\n",(0,s.jsxs)(t.li,{children:["Chain ID: ",(0,s.jsx)(t.code,{children:"59330"})]}),"\n",(0,s.jsxs)(t.li,{children:["Currency symbol: ",(0,s.jsx)(t.code,{children:"tFLK"})]}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"note",children:(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Testnet FLK"})," on testnets are supposed to have no real value. Since you need Testnet ",(0,s.jsx)(t.code,{children:"FLK"})," to actually interact with Fleek Network, users get ",(0,s.jsx)(t.code,{children:"Testnet FLK"})," for free from the faucet. For clarity and simplicity we'll refer to ",(0,s.jsx)(t.code,{children:"Testnet FLK"})," as ",(0,s.jsx)(t.code,{children:"tFLK"}),"."]})}),"\n",(0,s.jsx)(t.h3,{id:"3-visit-the-faucet-website",children:"3) Visit the faucet website"}),"\n",(0,s.jsxs)(t.p,{children:["Before proceeding, make sure to have the Fleek Network selected as the metamask network. Once confirmed, visit the ",(0,s.jsx)(t.a,{href:"https://faucet.testnet.fleek.network/",children:"Faucet website"})]}),"\n",(0,s.jsx)(t.h3,{id:"4-connect-wallet",children:"4) Connect wallet"}),"\n",(0,s.jsxs)(t.p,{children:["In the ",(0,s.jsx)(t.a,{href:"https://faucet.testnet.fleek.network/",children:"Faucet website"}),", you have to click the ",(0,s.jsx)(t.code,{children:"Connect Wallet"}),"."]}),"\n",(0,s.jsx)(t.h3,{id:"5-mint-tflk",children:"5) Mint tFLK"}),"\n",(0,s.jsxs)(t.p,{children:["Once ",(0,s.jsx)(t.code,{children:"Connect Wallet"})," is ready, proceed to ",(0,s.jsx)(t.code,{children:"Mint tFLK"})," and wait until the balance of the account in your Metamask increases. You need to have ",(0,s.jsx)(t.code,{children:"tFLK"})," before proceeding. Be patient."]}),"\n",(0,s.jsx)(t.h3,{id:"6-stake-tflk",children:"6) Stake tFLK"}),"\n",(0,s.jsxs)(t.p,{children:["Once ",(0,s.jsx)(t.code,{children:"tFLK"})," balance is available, click in the ",(0,s.jsx)(t.code,{children:"Stake"})," button. You'll be required to provided the following details from your node:"]}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Node Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Consensus Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Server IP Address"}),"\n"]}),"\n",(0,s.jsxs)(t.p,{children:["You can get the details quickly by running the ",(0,s.jsx)(t.strong,{children:"node details"})," script in the terminal connected to your machine or server where the node is set up and running, as follows:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"curl https://get.fleek.network/node_details | bash\n"})}),"\n",(0,s.jsx)(t.p,{children:"The response should include the following details:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"\ud83e\udd16 Your server details are the following\n\nThe Node Public Key is \nThe Consensus Public Key is \nThe Node Server IP address is \n"})}),"\n",(0,s.jsx)(t.admonition,{title:"warning",type:"caution",children:(0,s.jsxs)(t.p,{children:["The output above is an example, you'll not find the actual text ",(0,s.jsx)(t.code,{children:""}),", ",(0,s.jsx)(t.code,{children:""})," but the text values (string of bits), or ",(0,s.jsx)(t.code,{children:""})," where instead you'll find a numerical ip address.\nMake sure that you copy and paste the correct values otherwise the transaction will fail!"]})}),"\n",(0,s.jsx)(t.h3,{id:"7-confirm-the-transaction-on-metamask",children:"7) Confirm the transaction on metamask"}),"\n",(0,s.jsx)(t.p,{children:"It is important to note that when transacting through Metamask, a warning message might pop up regarding gas costs, but rest assured that there won't be any deductions from your wallet balance."}),"\n",(0,s.jsx)(t.p,{children:"You'll have to wait for Metamask to confirm the transaction, which Metamask should take about 10 seconds to confirm. Although, the transaction takes under a second."}),"\n",(0,s.jsxs)(t.p,{children:["Important to note that in Testnet Phase ",1," the Epoch is set to about 30 minutes. This is the average period you'll have to wait to see any meaningful logs."]}),"\n",(0,s.jsx)(t.h3,{id:"8-start-the-node",children:"8) Start the Node"}),"\n",(0,s.jsxs)(t.p,{children:["Visit the section ",(0,s.jsx)(t.a,{href:"/docs/node/systemd-service",children:"Systemd Service"})," to learn how to enable, disable, start, stop the Systemd Service."]}),"\n",(0,s.jsx)(t.admonition,{type:"note",children:(0,s.jsxs)(t.p,{children:["The Systemd Service is setup automatically by the assisted installer, manually if you have followed the instructions provided, or the docker install. If you have a custom set up, you'll have to do the equivalent to start the node as described in the section ",(0,s.jsx)(t.a,{href:"/docs/node/systemd-service",children:"Systemd Service"}),"."]})}),"\n",(0,s.jsx)(t.p,{children:"Make sure you do a quick healthcheck:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{children:"curl https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,s.jsxs)(t.p,{children:["To learn more about healchecks read the section ",(0,s.jsx)(t.a,{href:"/docs/node/health-check",children:"here"}),"."]}),"\n",(0,s.jsx)(t.h3,{id:"9-confirm-node-stake",children:"9) Confirm Node Stake"}),"\n",(0,s.jsxs)(t.p,{children:["To confirm the Node Staked amount, you can run the ",(0,s.jsx)(t.strong,{children:"node details"})," script to get the information. The ",(0,s.jsx)(t.strong,{children:"node details"})," output will only show staked information if available, if it doesn't show staked information it means that your Node is not properly staked."]}),"\n",(0,s.jsx)(t.p,{children:"Check the Node stake by running the following command in the machine or server where the node is set up:"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"curl https://get.fleek.network/node_details | bash\n"})}),"\n",(0,s.jsxs)(t.p,{children:["Alternatively, the Stake amount can be verified by querying the ",(0,s.jsx)(t.a,{href:"/docs/learn/the-network/#json-rpc-interface",children:"RPC-JSON API"})," method ",(0,s.jsx)(t.code,{children:"flk_get_node_info"}),"."]}),"\n",(0,s.jsx)(t.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsx)(t.h3,{id:"the-node-fails-to-run-after-successfully-stake-and-run-or-the-core-team-network-restart-announcement",children:"The Node fails to run after successfully stake and run? Or the Core team network restart announcement?"}),"\n",(0,s.jsxs)(t.p,{children:["The Fleek Network core team might have to restart the network, for any development purposes or required updates during the Testnet Phase ",1,". If you've done this process before and is running into issues, you'll have to go into the Metamask advance settings (Metamask \u2192 Settings \u2192 Advanced) and click ",(0,s.jsx)(t.code,{children:"Clear activity and nonce data"})," or ",(0,s.jsx)(t.code,{children:"Clear Local data"}),". After doing this Metamask will clear the cache."]}),"\n",(0,s.jsx)(t.h3,{id:"node-details-dont-show-staked-amount",children:"Node details don't show staked amount?"}),"\n",(0,s.jsxs)(t.p,{children:["If you have staked successfully and the transaction details in the Metamask wallet is confirmed, but the ",(0,s.jsx)(t.strong,{children:"node details"})," script or the ",(0,s.jsx)(t.a,{href:"/docs/learn/the-network/#json-rpc-interface",children:"RPC-JSON API"})," method ",(0,s.jsx)(t.code,{children:"flk_get_node_info"})," shows an empty result, do the following:"]}),"\n",(0,s.jsx)(t.p,{children:"Metamask:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Copy the Account address at the very top of your Metamask home"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Transaction ID by clicking in the tFLK transaction \u2192 Copy Transaction ID at the very top"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Activity log details of the transaction"}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Server where the Node is set up:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"Copy the Node Public Key"}),"\n",(0,s.jsx)(t.li,{children:"Copy the Server IP Address"}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"tip",children:(0,s.jsxs)(t.p,{children:["You can get the Node Public Key and Server IP Address quick by using the ",(0,s.jsx)(t.a,{href:"#6-stake-tflk",children:"node details"})," script described in the section."]})}),"\n",(0,s.jsxs)(t.p,{children:["Report to us by sharing the details about via our ",(0,s.jsx)(t.a,{href:"https://discord.gg/fleekxyz",children:"discord"})," troubleshooting channel."]}),"\n",(0,s.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>o});n(7294);var s=n(5893);const o=e=>{let{image:t,name:n,title:o,url:i,communityMember:r=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:n,children:(0,s.jsx)("img",{src:t,alt:n})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:i,target:"_blank",alt:n,children:n})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var s=n(7294);const o={},i=s.createContext(o);function r(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6be32138.327ad97b.js b/assets/js/6be32138.7384c59d.js similarity index 99% rename from assets/js/6be32138.327ad97b.js rename to assets/js/6be32138.7384c59d.js index 38fe83ac6..c640e1b18 100644 --- a/assets/js/6be32138.327ad97b.js +++ b/assets/js/6be32138.7384c59d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[3396],{3103:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var n=i(5893),o=i(1151);const r={title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},s=void 0,a={permalink:"/blog/bloom-and-cuckoo-filters-for-cache-summarization",source:"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md",title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",date:"2023-11-03T16:36:44.000Z",formattedDate:"November 3, 2023",tags:[{label:"fleek network",permalink:"/blog/tags/fleek-network"},{label:"blog",permalink:"/blog/tags/blog"},{label:"engineering",permalink:"/blog/tags/engineering"},{label:"content routing",permalink:"/blog/tags/content-routing"}],readingTime:10.37,hasTruncateMarker:!0,authors:[{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"}],frontMatter:{title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},unlisted:!1},l={image:i(9969).Z,authorsImageUrls:[void 0]},c=[{value:"Background",id:"background",level:2},{value:"Bloom Filters",id:"bloom-filters",level:2},{value:"Cuckoo Filters",id:"cuckoo-filters",level:2},{value:"Benchmarking",id:"benchmarking",level:2},{value:"Experimental Setup",id:"experimental-setup",level:2},{value:"Memory Footprint",id:"memory-footprint",level:2},{value:"Lookup Performance",id:"lookup-performance",level:2},{value:"Insertion Performance",id:"insertion-performance",level:2},{value:"Capacity and Scaling",id:"capacity-and-scaling",level:2},{value:"Other Filters",id:"other-filters",level:2},{value:"Conclusion",id:"conclusion",level:2},{value:"References",id:"references",level:3}];function h(e){const t={a:"a",blockquote:"blockquote",br:"br",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case."}),"\n",(0,n.jsx)(t.h2,{id:"background",children:"Background"}),"\n",(0,n.jsx)(t.p,{children:"Nodes on Fleek Network currently use Counting Bloom filters to summarize their cached content. These cache summaries are exchanged with other nodes in order to facilitate content routing."}),"\n",(0,n.jsx)(t.p,{children:"If a particular node does not store a requested piece of content, it can use the Bloom filters that it received from its peers to check if a peer stores the requested content."}),"\n",(0,n.jsx)(t.p,{children:"We are using Counting Bloom filters rather than regular Bloom filters because we need to be able to remove elements from the filter to support cache eviction."}),"\n",(0,n.jsx)(t.h2,{id:"bloom-filters",children:"Bloom Filters"}),"\n",(0,n.jsxs)(t.p,{children:["A Bloom filter is a space-efficient probabilistic data structure that can be used to perform approximate set membership queries.\nThe answer to an approximate set membership query is not ",(0,n.jsx)(t.code,{children:"no"})," or ",(0,n.jsx)(t.code,{children:"yes,"})," but rather ",(0,n.jsx)(t.code,{children:"no"})," or ",(0,n.jsx)(t.code,{children:"probably."})," This ",(0,n.jsx)(t.code,{children:"probably"})," is quantified with the false positive rate."]}),"\n",(0,n.jsxs)(t.p,{children:["One of the convenient features of Bloom filters is that they can be configured to have a specific false positive rate.\nOf course, there is a tradeoff here; the lower the false positive rate, the larger the memory footprint. Bloom filters support two operations: ",(0,n.jsx)(t.code,{children:"insert"})," and ",(0,n.jsx)(t.code,{children:"contains."})]}),"\n",(0,n.jsxs)(t.p,{children:["A Bloom filter is represented by an array of m bits together with k independent hash functions. To insert an element into the filter, it is hashed with each of the k hash functions.\nThe resulting hashes are interpreted as integers (modulo m) to obtain k array positions. The bits at these positions are then set to 1 (if there aren't already 1).",(0,n.jsx)(t.br,{}),"\n","To check whether or not an element is contained in the filter, the element is hashed k times with the different hash functions."]}),"\n",(0,n.jsx)(t.p,{children:"If all bits at the resulting array positions are 1, the element is assumed to be present. If any of the k bits are zero, we can be certain that the queried element is not present in the set."}),"\n",(0,n.jsx)(t.p,{children:"However, even if all bits are 1, it might still be the case that the bits were set by a combination of other elements. This is where the aforementioned false positive rate comes into play."}),"\n",(0,n.jsxs)(t.p,{children:["Since we also need a ",(0,n.jsx)(t.code,{children:"remove"})," operation for our use case, we have been using Counting Bloom filters, a variant of Bloom filters.\nCounting Bloom filters retain most of the properties that regular Bloom filters have. The ",(0,n.jsx)(t.code,{children:"remove"})," operation comes at the cost of an increased memory footprint."]}),"\n",(0,n.jsx)(t.p,{children:"Each position in the array is no longer a single bit but a group of bits representing a counter.\nWhenever an element is inserted into the filter, the counters for all k positions are incremented by 1. To remove an element, we decrement the counters."}),"\n",(0,n.jsx)(t.h2,{id:"cuckoo-filters",children:"Cuckoo Filters"}),"\n",(0,n.jsx)(t.p,{children:"Bloom filters are the most known members of a class of data structures called Approximate Membership Query Filters (AMQ Filters).\nA relatively recent addition to this class is the Cuckoo filter [1]. Cuckoo filters share many similarities with Bloom filters, especially Counting Bloom filters."}),"\n",(0,n.jsxs)(t.p,{children:["They are space-efficient and can be used for approximate set membership queries. Cuckoo filters also support the operations ",(0,n.jsx)(t.code,{children:"insert,"})," ",(0,n.jsx)(t.code,{children:"contains,"})," and ",(0,n.jsx)(t.code,{children:"remove,"})," and have configurable false positive rates."]}),"\n",(0,n.jsx)(t.p,{children:"Cuckoo filters are based on Cuckoo hash tables [2] and leverage an optimization called partial-key cuckoo hashing. A basic Cuckoo hash table consists of an array of buckets.\nWe determine two candidate buckets for each element using two different hash functions, h1 and h2."}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.code,{children:"contains"})," operation will check if either bucket contains the element.\nFor insertion, if either bucket is empty, the element will be inserted into the empty bucket."]}),"\n",(0,n.jsx)(t.p,{children:"If neither bucket is empty, one of the buckets is selected, and the existing element is removed and inserted into its alternate location.\nThis may trigger another relocation if the alternate location is not empty."}),"\n",(0,n.jsx)(t.p,{children:"Although the insertion operation may perform a sequence of relocations, the amortized runtime is O(1)."}),"\n",(0,n.jsx)(t.p,{children:"Most implementations of Cuckoo hash tables and, consequently, Cuckoo filters will use buckets that can hold multiple elements, as proposed in [3]."}),"\n",(0,n.jsx)(t.p,{children:"For Cuckoo filters, the hash table size is reduced by only storing fingerprints - a bit string calculated from an element's hash - rather than key-value pairs."}),"\n",(0,n.jsxs)(t.p,{children:["The fingerprint size is derived from the desired false positive rate.",(0,n.jsx)(t.br,{}),"\n","A problem that arises is that, to relocate existing fingerprints using the Cuckoo hashing approach described above, we need the original hash from which the fingerprint was derived."]}),"\n",(0,n.jsx)(t.p,{children:"Of course, we could store this hash somewhere, but the whole point of using fingerprints is to reduce the memory footprint of the filter."}),"\n",(0,n.jsxs)(t.p,{children:["The solution to this predicament is the aforementioned partial-key cuckoo hashing, a technique for determining an element's alternate location using only its fingerprint.",(0,n.jsx)(t.br,{}),"\n","For a given element x, the two candidate buckets are computed as follows:"]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(9440).Z+"",width:"1324",height:"194"})}),"\n",(0,n.jsx)(t.p,{children:"An important property of this technique is that h1(x) can also be computed from h2(x) and the fingerprint."}),"\n",(0,n.jsx)(t.h2,{id:"benchmarking",children:"Benchmarking"}),"\n",(0,n.jsx)(t.p,{children:"As this post mentioned, we are not aiming for a general comparison of Counting Bloom and Cuckoo filters."}),"\n",(0,n.jsx)(t.p,{children:"Instead, we want to determine which filter suits our specific use case better. The two main properties we are looking for are space efficiency and lookup performance."}),"\n",(0,n.jsx)(t.p,{children:"Space efficiency is important because nodes frequently update their cache and have to communicate these changes with their peers. These messages should take up as little bandwidth as possible."}),"\n",(0,n.jsx)(t.p,{children:"Lookup speed is also important because Fleek Network aims to serve user requests as quickly as possible. Checking whether a peer has some content stored in their cache summary should not be a bottleneck."}),"\n",(0,n.jsx)(t.h2,{id:"experimental-setup",children:"Experimental Setup"}),"\n",(0,n.jsxs)(t.p,{children:["We are using our own Counting Bloom filter ",(0,n.jsx)(t.a,{href:"https://github.com/fleek-network/ursa/blob/483f4d56cbaa5e83182454d2c1db6f6af7c54912/crates/ursa-network/src/utils/bloom_filter.rs#L11",children:"implementation"})," and ",(0,n.jsx)(t.a,{href:"https://github.com/sile/scalable_cuckoo_filter?gh",children:"scalable cuckoo filter"})," Cuckoo filter implementation in Rust, the ",(0,n.jsx)(t.a,{href:"https://github.com/efficient/cuckoofilter?gh",children:"original cuckoofilter"})," implementation is in C++. All experiments were performed on a Linux machine with 16 GB RAM and an Intel Core i7 (10th Gen). Whenever the experiment is probabilistic, we repeat the experiment 20 times and report the mean and standard deviation."]}),"\n",(0,n.jsx)(t.h2,{id:"memory-footprint",children:"Memory Footprint"}),"\n",(0,n.jsx)(t.p,{children:"For both Counting Bloom filters and Cuckoo filters, the memory footprint is determined by two factors: the filter's capacity and the desired false positive rate. In the first experiment, we examine the impact that\nthese factors have on the memory footprint."}),"\n",(0,n.jsx)(t.p,{children:"To this end, we fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The result is shown in Fig. 1.\nThe size of Bloom filters scales linearly with the capacity. Cuckoo filters are more space-efficient. This result is consistent with the experiments reported in [1]."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(5441).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 1: We fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The y-axis shows the size of the filters in Megabytes."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Next, we fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. Fig. 2 shows that Cuckoo filters are more space-efficient."}),"\n",(0,n.jsx)(t.p,{children:"The gap between Counting Bloom filters and Cuckoo filters grows as the false positive rate decreases. This is also consistent with experiments in [1]."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(9844).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 2: We fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. The y-axis shows the size of the filters in Megabytes."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"lookup-performance",children:"Lookup Performance"}),"\n",(0,n.jsx)(t.p,{children:"We first add elements to both filters until the capacity is reached. We then measure the lookup performance for different ratios of positive and negative lookups."}),"\n",(0,n.jsx)(t.p,{children:"A positive lookup is for an existing element, and a negative lookup is for an element not contained in the filter. We perform 100K lookups for each ratio and report the average lookup duration and standard deviation."}),"\n",(0,n.jsx)(t.p,{children:"Fig. 3 shows the results. Bloom filters perform slightly better on average than Cuckoo filters. This result is inconsistent with [1],\nwhere Cuckoo filters were reported to have a better lookup performance than Bloom filters. It should be noted here that the authors in [1] use the original C++ Cuckoo filter implementation and their own unreleased Bloom filter implementation. In contrast, we use a Rust Cuckoo filter implementation and our Bloom filter implementation. We cannot easily determine the reason for this discrepancy."}),"\n",(0,n.jsx)(t.p,{children:"However, the performance difference is negligible."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(8915).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 3: Lookup performance for different ratios of positive and negative lookups. For example, ratio 0.25 indicates that 25% of lookups are positive and 75% are negative.\nThe shaded region indicates the standard deviation."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"insertion-performance",children:"Insertion Performance"}),"\n",(0,n.jsx)(t.p,{children:"Less critical than lookup performance but still important for our purposes is insertion performance. We measure how the insertion performance varies for different occupancy levels.\nFig. 4 shows the results. The insertion performance is constant across all levels of occupancy for Bloom filters."}),"\n",(0,n.jsx)(t.p,{children:"For Cuckoo filters, the performance decreases as the filter becomes fuller because more relocations are required. In Fig. 4, the performance for Bloom filters is not constant. It quickly increases and then remains constant. This can be explained by CPU caching."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(989).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 4: Insertion performance for different occupancy levels. The shaded region indicates the standard deviation."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"capacity-and-scaling",children:"Capacity and Scaling"}),"\n",(0,n.jsx)(t.p,{children:"We have mentioned the capacity of a filter several times now. An interesting case is what happens when a filter's capacity is exceeded.\nBloom filters and Cuckoo filters behave differently in this scenario."}),"\n",(0,n.jsxs)(t.p,{children:["For Bloom filters, the ",(0,n.jsx)(t.code,{children:"insertion"})," operation always succeeds. However, the false positive rate will rapidly increase as we exceed the filter's capacity. While Bloom filters fail silently, Cuckoo filters are more explicit. Most implementations have a maximum number of\nrelocations that will be performed for an insertion. The ",(0,n.jsx)(t.code,{children:"insertion"})," operation will return an error if more relocations are required."]}),"\n",(0,n.jsx)(t.p,{children:"For both filters, we can avoid this problem by simply initializing the filter with a sufficiently large capacity. However, this will increase the memory footprint of the filter."}),"\n",(0,n.jsx)(t.p,{children:"Furthermore, it is difficult to predict how many elements a node on Fleek Network will cache. It is also likely that the number of cached elements will greatly vary for different nodes."}),"\n",(0,n.jsx)(t.p,{children:"Fortunately, a variant of Bloom filters called Scalable Bloom Filters [4] can adapt dynamically to the number of elements stored while guaranteeing a maximum false positive rate."}),"\n",(0,n.jsx)(t.p,{children:"The proposed technique is also applicable to Cuckoo filters."}),"\n",(0,n.jsx)(t.h2,{id:"other-filters",children:"Other Filters"}),"\n",(0,n.jsx)(t.p,{children:"While we only looked at Bloom filters and Cuckoo filters, there are other AMQ filters that we want to mention here briefly:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["\n",(0,n.jsx)(t.p,{children:"Quotient filters [5, 6]: Compact hash tables that support insertion, lookup, and deletion. Less space-efficient than Bloom filters and Cuckoo filters."}),"\n"]}),"\n",(0,n.jsxs)(t.li,{children:["\n",(0,n.jsx)(t.p,{children:"XOR filters [7]: More space-efficient than Bloom filters and Cuckoo filters. However, they are static, meaning the filter has to be rebuilt if additional elements are added."}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,n.jsx)(t.p,{children:"We examined whether Counting Bloom filters or Cuckoo filters are more suitable for summarizing caches on Fleek Network. Cuckoo filters are more space-efficient, especially for lower false positive rates. Bloom filters have a slightly better insertion and lookup performance for the implementations we tested."}),"\n",(0,n.jsx)(t.p,{children:"Both filters can be adapted to grow and shrink in size dynamically. Since the difference in insertion and lookup performance is negligible while Cuckoo filters are significantly more space-efficient, we favor Cuckoo filters for our use case."}),"\n",(0,n.jsx)(t.h3,{id:"references",children:"References"}),"\n",(0,n.jsx)(t.p,{children:"[1] Bin Fan, Dave G. Andersen, Michael Kaminsky, and Michael D. Mitzenmacher. Cuckoo Filter: Practically Better Than Bloom.\nIn Proceedings of the 10th ACM International Conference on emerging Networking Experiments and Technologies (CoNEXT 14). Association for Computing Machinery, New York, NY, USA, pp. 75-88, 2014."}),"\n",(0,n.jsx)(t.p,{children:"[2] Rasmus Pagha and Flemming Friche Rodler. Cuckoo hashing. Journal of Algorithms, 51(2), pp. 122-144, 2004."}),"\n",(0,n.jsx)(t.p,{children:"[3] Martin Dietzfelbinger and Christoph Weidling. Balanced Allocation and Dictionaries with Tightly Packed Constant Size Bins. Theoretical Computer Science, 380(1), pp. 47-68, 2007."}),"\n",(0,n.jsx)(t.p,{children:"[4] Paulo S. Almeida, Carlos Baquero, Nuno Pregui\xe7a, and David Hutchison. Scalable Bloom Filters. Information Processing Letters, 101(6), pp. 255-261, 2007."}),"\n",(0,n.jsx)(t.p,{children:"[5] John G. Cleary. Compact hash tables using bidirectional linear probing. IEEE Transactions on Computers. 33(9), pp. 828-834, 1984."}),"\n",(0,n.jsx)(t.p,{children:"[6] Anna Pagh, Rasmus Pagh, and S. Srinivasa Rao. An optimal Bloom filter replacement. Proceedings of the Sixteenth Annual ACM-SIAM Symposium on Discrete Algorithms, pp. 823-829, 2005."}),"\n",(0,n.jsx)(t.p,{children:"[7] Thomas Mueller Graf and Daniel Lemire. Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters. ACM Journal of Experimental Algorithmics. 25, pp. 1-16, 2020."})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},9969:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/bloom-79da0db687b4fb2060758838b9c44513.png"},5441:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/capacity-size-5c2576bd69db0e5b510781e7cc1c5257.png"},9844:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/fp-rate-size-fbb54b2450b4a91e28c97d8adf0253e8.png"},989:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/insert-3ff48d4c63724adcf399f81b29607691.png"},8915:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/lookup-e36011237d8602b5f6c36fe5dd145bf5.png"},9440:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/math-formul-a247d4df475b26b1e7cbb2acfc0ab8c2.png"},1151:(e,t,i)=>{i.d(t,{Z:()=>a,a:()=>s});var n=i(7294);const o={},r=n.createContext(o);function s(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[3396],{3103:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var n=i(5893),o=i(1151);const r={title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},s=void 0,a={permalink:"/blog/bloom-and-cuckoo-filters-for-cache-summarization",source:"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md",title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",date:"2023-11-03T16:48:06.000Z",formattedDate:"November 3, 2023",tags:[{label:"fleek network",permalink:"/blog/tags/fleek-network"},{label:"blog",permalink:"/blog/tags/blog"},{label:"engineering",permalink:"/blog/tags/engineering"},{label:"content routing",permalink:"/blog/tags/content-routing"}],readingTime:10.37,hasTruncateMarker:!0,authors:[{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"}],frontMatter:{title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},unlisted:!1},l={image:i(9969).Z,authorsImageUrls:[void 0]},c=[{value:"Background",id:"background",level:2},{value:"Bloom Filters",id:"bloom-filters",level:2},{value:"Cuckoo Filters",id:"cuckoo-filters",level:2},{value:"Benchmarking",id:"benchmarking",level:2},{value:"Experimental Setup",id:"experimental-setup",level:2},{value:"Memory Footprint",id:"memory-footprint",level:2},{value:"Lookup Performance",id:"lookup-performance",level:2},{value:"Insertion Performance",id:"insertion-performance",level:2},{value:"Capacity and Scaling",id:"capacity-and-scaling",level:2},{value:"Other Filters",id:"other-filters",level:2},{value:"Conclusion",id:"conclusion",level:2},{value:"References",id:"references",level:3}];function h(e){const t={a:"a",blockquote:"blockquote",br:"br",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,o.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case."}),"\n",(0,n.jsx)(t.h2,{id:"background",children:"Background"}),"\n",(0,n.jsx)(t.p,{children:"Nodes on Fleek Network currently use Counting Bloom filters to summarize their cached content. These cache summaries are exchanged with other nodes in order to facilitate content routing."}),"\n",(0,n.jsx)(t.p,{children:"If a particular node does not store a requested piece of content, it can use the Bloom filters that it received from its peers to check if a peer stores the requested content."}),"\n",(0,n.jsx)(t.p,{children:"We are using Counting Bloom filters rather than regular Bloom filters because we need to be able to remove elements from the filter to support cache eviction."}),"\n",(0,n.jsx)(t.h2,{id:"bloom-filters",children:"Bloom Filters"}),"\n",(0,n.jsxs)(t.p,{children:["A Bloom filter is a space-efficient probabilistic data structure that can be used to perform approximate set membership queries.\nThe answer to an approximate set membership query is not ",(0,n.jsx)(t.code,{children:"no"})," or ",(0,n.jsx)(t.code,{children:"yes,"})," but rather ",(0,n.jsx)(t.code,{children:"no"})," or ",(0,n.jsx)(t.code,{children:"probably."})," This ",(0,n.jsx)(t.code,{children:"probably"})," is quantified with the false positive rate."]}),"\n",(0,n.jsxs)(t.p,{children:["One of the convenient features of Bloom filters is that they can be configured to have a specific false positive rate.\nOf course, there is a tradeoff here; the lower the false positive rate, the larger the memory footprint. Bloom filters support two operations: ",(0,n.jsx)(t.code,{children:"insert"})," and ",(0,n.jsx)(t.code,{children:"contains."})]}),"\n",(0,n.jsxs)(t.p,{children:["A Bloom filter is represented by an array of m bits together with k independent hash functions. To insert an element into the filter, it is hashed with each of the k hash functions.\nThe resulting hashes are interpreted as integers (modulo m) to obtain k array positions. The bits at these positions are then set to 1 (if there aren't already 1).",(0,n.jsx)(t.br,{}),"\n","To check whether or not an element is contained in the filter, the element is hashed k times with the different hash functions."]}),"\n",(0,n.jsx)(t.p,{children:"If all bits at the resulting array positions are 1, the element is assumed to be present. If any of the k bits are zero, we can be certain that the queried element is not present in the set."}),"\n",(0,n.jsx)(t.p,{children:"However, even if all bits are 1, it might still be the case that the bits were set by a combination of other elements. This is where the aforementioned false positive rate comes into play."}),"\n",(0,n.jsxs)(t.p,{children:["Since we also need a ",(0,n.jsx)(t.code,{children:"remove"})," operation for our use case, we have been using Counting Bloom filters, a variant of Bloom filters.\nCounting Bloom filters retain most of the properties that regular Bloom filters have. The ",(0,n.jsx)(t.code,{children:"remove"})," operation comes at the cost of an increased memory footprint."]}),"\n",(0,n.jsx)(t.p,{children:"Each position in the array is no longer a single bit but a group of bits representing a counter.\nWhenever an element is inserted into the filter, the counters for all k positions are incremented by 1. To remove an element, we decrement the counters."}),"\n",(0,n.jsx)(t.h2,{id:"cuckoo-filters",children:"Cuckoo Filters"}),"\n",(0,n.jsx)(t.p,{children:"Bloom filters are the most known members of a class of data structures called Approximate Membership Query Filters (AMQ Filters).\nA relatively recent addition to this class is the Cuckoo filter [1]. Cuckoo filters share many similarities with Bloom filters, especially Counting Bloom filters."}),"\n",(0,n.jsxs)(t.p,{children:["They are space-efficient and can be used for approximate set membership queries. Cuckoo filters also support the operations ",(0,n.jsx)(t.code,{children:"insert,"})," ",(0,n.jsx)(t.code,{children:"contains,"})," and ",(0,n.jsx)(t.code,{children:"remove,"})," and have configurable false positive rates."]}),"\n",(0,n.jsx)(t.p,{children:"Cuckoo filters are based on Cuckoo hash tables [2] and leverage an optimization called partial-key cuckoo hashing. A basic Cuckoo hash table consists of an array of buckets.\nWe determine two candidate buckets for each element using two different hash functions, h1 and h2."}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.code,{children:"contains"})," operation will check if either bucket contains the element.\nFor insertion, if either bucket is empty, the element will be inserted into the empty bucket."]}),"\n",(0,n.jsx)(t.p,{children:"If neither bucket is empty, one of the buckets is selected, and the existing element is removed and inserted into its alternate location.\nThis may trigger another relocation if the alternate location is not empty."}),"\n",(0,n.jsx)(t.p,{children:"Although the insertion operation may perform a sequence of relocations, the amortized runtime is O(1)."}),"\n",(0,n.jsx)(t.p,{children:"Most implementations of Cuckoo hash tables and, consequently, Cuckoo filters will use buckets that can hold multiple elements, as proposed in [3]."}),"\n",(0,n.jsx)(t.p,{children:"For Cuckoo filters, the hash table size is reduced by only storing fingerprints - a bit string calculated from an element's hash - rather than key-value pairs."}),"\n",(0,n.jsxs)(t.p,{children:["The fingerprint size is derived from the desired false positive rate.",(0,n.jsx)(t.br,{}),"\n","A problem that arises is that, to relocate existing fingerprints using the Cuckoo hashing approach described above, we need the original hash from which the fingerprint was derived."]}),"\n",(0,n.jsx)(t.p,{children:"Of course, we could store this hash somewhere, but the whole point of using fingerprints is to reduce the memory footprint of the filter."}),"\n",(0,n.jsxs)(t.p,{children:["The solution to this predicament is the aforementioned partial-key cuckoo hashing, a technique for determining an element's alternate location using only its fingerprint.",(0,n.jsx)(t.br,{}),"\n","For a given element x, the two candidate buckets are computed as follows:"]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(9440).Z+"",width:"1324",height:"194"})}),"\n",(0,n.jsx)(t.p,{children:"An important property of this technique is that h1(x) can also be computed from h2(x) and the fingerprint."}),"\n",(0,n.jsx)(t.h2,{id:"benchmarking",children:"Benchmarking"}),"\n",(0,n.jsx)(t.p,{children:"As this post mentioned, we are not aiming for a general comparison of Counting Bloom and Cuckoo filters."}),"\n",(0,n.jsx)(t.p,{children:"Instead, we want to determine which filter suits our specific use case better. The two main properties we are looking for are space efficiency and lookup performance."}),"\n",(0,n.jsx)(t.p,{children:"Space efficiency is important because nodes frequently update their cache and have to communicate these changes with their peers. These messages should take up as little bandwidth as possible."}),"\n",(0,n.jsx)(t.p,{children:"Lookup speed is also important because Fleek Network aims to serve user requests as quickly as possible. Checking whether a peer has some content stored in their cache summary should not be a bottleneck."}),"\n",(0,n.jsx)(t.h2,{id:"experimental-setup",children:"Experimental Setup"}),"\n",(0,n.jsxs)(t.p,{children:["We are using our own Counting Bloom filter ",(0,n.jsx)(t.a,{href:"https://github.com/fleek-network/ursa/blob/483f4d56cbaa5e83182454d2c1db6f6af7c54912/crates/ursa-network/src/utils/bloom_filter.rs#L11",children:"implementation"})," and ",(0,n.jsx)(t.a,{href:"https://github.com/sile/scalable_cuckoo_filter?gh",children:"scalable cuckoo filter"})," Cuckoo filter implementation in Rust, the ",(0,n.jsx)(t.a,{href:"https://github.com/efficient/cuckoofilter?gh",children:"original cuckoofilter"})," implementation is in C++. All experiments were performed on a Linux machine with 16 GB RAM and an Intel Core i7 (10th Gen). Whenever the experiment is probabilistic, we repeat the experiment 20 times and report the mean and standard deviation."]}),"\n",(0,n.jsx)(t.h2,{id:"memory-footprint",children:"Memory Footprint"}),"\n",(0,n.jsx)(t.p,{children:"For both Counting Bloom filters and Cuckoo filters, the memory footprint is determined by two factors: the filter's capacity and the desired false positive rate. In the first experiment, we examine the impact that\nthese factors have on the memory footprint."}),"\n",(0,n.jsx)(t.p,{children:"To this end, we fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The result is shown in Fig. 1.\nThe size of Bloom filters scales linearly with the capacity. Cuckoo filters are more space-efficient. This result is consistent with the experiments reported in [1]."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(5441).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 1: We fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The y-axis shows the size of the filters in Megabytes."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Next, we fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. Fig. 2 shows that Cuckoo filters are more space-efficient."}),"\n",(0,n.jsx)(t.p,{children:"The gap between Counting Bloom filters and Cuckoo filters grows as the false positive rate decreases. This is also consistent with experiments in [1]."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(9844).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 2: We fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. The y-axis shows the size of the filters in Megabytes."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"lookup-performance",children:"Lookup Performance"}),"\n",(0,n.jsx)(t.p,{children:"We first add elements to both filters until the capacity is reached. We then measure the lookup performance for different ratios of positive and negative lookups."}),"\n",(0,n.jsx)(t.p,{children:"A positive lookup is for an existing element, and a negative lookup is for an element not contained in the filter. We perform 100K lookups for each ratio and report the average lookup duration and standard deviation."}),"\n",(0,n.jsx)(t.p,{children:"Fig. 3 shows the results. Bloom filters perform slightly better on average than Cuckoo filters. This result is inconsistent with [1],\nwhere Cuckoo filters were reported to have a better lookup performance than Bloom filters. It should be noted here that the authors in [1] use the original C++ Cuckoo filter implementation and their own unreleased Bloom filter implementation. In contrast, we use a Rust Cuckoo filter implementation and our Bloom filter implementation. We cannot easily determine the reason for this discrepancy."}),"\n",(0,n.jsx)(t.p,{children:"However, the performance difference is negligible."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(8915).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 3: Lookup performance for different ratios of positive and negative lookups. For example, ratio 0.25 indicates that 25% of lookups are positive and 75% are negative.\nThe shaded region indicates the standard deviation."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"insertion-performance",children:"Insertion Performance"}),"\n",(0,n.jsx)(t.p,{children:"Less critical than lookup performance but still important for our purposes is insertion performance. We measure how the insertion performance varies for different occupancy levels.\nFig. 4 shows the results. The insertion performance is constant across all levels of occupancy for Bloom filters."}),"\n",(0,n.jsx)(t.p,{children:"For Cuckoo filters, the performance decreases as the filter becomes fuller because more relocations are required. In Fig. 4, the performance for Bloom filters is not constant. It quickly increases and then remains constant. This can be explained by CPU caching."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.img,{src:i(989).Z+"",width:"640",height:"480"})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Figure 4: Insertion performance for different occupancy levels. The shaded region indicates the standard deviation."}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"capacity-and-scaling",children:"Capacity and Scaling"}),"\n",(0,n.jsx)(t.p,{children:"We have mentioned the capacity of a filter several times now. An interesting case is what happens when a filter's capacity is exceeded.\nBloom filters and Cuckoo filters behave differently in this scenario."}),"\n",(0,n.jsxs)(t.p,{children:["For Bloom filters, the ",(0,n.jsx)(t.code,{children:"insertion"})," operation always succeeds. However, the false positive rate will rapidly increase as we exceed the filter's capacity. While Bloom filters fail silently, Cuckoo filters are more explicit. Most implementations have a maximum number of\nrelocations that will be performed for an insertion. The ",(0,n.jsx)(t.code,{children:"insertion"})," operation will return an error if more relocations are required."]}),"\n",(0,n.jsx)(t.p,{children:"For both filters, we can avoid this problem by simply initializing the filter with a sufficiently large capacity. However, this will increase the memory footprint of the filter."}),"\n",(0,n.jsx)(t.p,{children:"Furthermore, it is difficult to predict how many elements a node on Fleek Network will cache. It is also likely that the number of cached elements will greatly vary for different nodes."}),"\n",(0,n.jsx)(t.p,{children:"Fortunately, a variant of Bloom filters called Scalable Bloom Filters [4] can adapt dynamically to the number of elements stored while guaranteeing a maximum false positive rate."}),"\n",(0,n.jsx)(t.p,{children:"The proposed technique is also applicable to Cuckoo filters."}),"\n",(0,n.jsx)(t.h2,{id:"other-filters",children:"Other Filters"}),"\n",(0,n.jsx)(t.p,{children:"While we only looked at Bloom filters and Cuckoo filters, there are other AMQ filters that we want to mention here briefly:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:["\n",(0,n.jsx)(t.p,{children:"Quotient filters [5, 6]: Compact hash tables that support insertion, lookup, and deletion. Less space-efficient than Bloom filters and Cuckoo filters."}),"\n"]}),"\n",(0,n.jsxs)(t.li,{children:["\n",(0,n.jsx)(t.p,{children:"XOR filters [7]: More space-efficient than Bloom filters and Cuckoo filters. However, they are static, meaning the filter has to be rebuilt if additional elements are added."}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"conclusion",children:"Conclusion"}),"\n",(0,n.jsx)(t.p,{children:"We examined whether Counting Bloom filters or Cuckoo filters are more suitable for summarizing caches on Fleek Network. Cuckoo filters are more space-efficient, especially for lower false positive rates. Bloom filters have a slightly better insertion and lookup performance for the implementations we tested."}),"\n",(0,n.jsx)(t.p,{children:"Both filters can be adapted to grow and shrink in size dynamically. Since the difference in insertion and lookup performance is negligible while Cuckoo filters are significantly more space-efficient, we favor Cuckoo filters for our use case."}),"\n",(0,n.jsx)(t.h3,{id:"references",children:"References"}),"\n",(0,n.jsx)(t.p,{children:"[1] Bin Fan, Dave G. Andersen, Michael Kaminsky, and Michael D. Mitzenmacher. Cuckoo Filter: Practically Better Than Bloom.\nIn Proceedings of the 10th ACM International Conference on emerging Networking Experiments and Technologies (CoNEXT 14). Association for Computing Machinery, New York, NY, USA, pp. 75-88, 2014."}),"\n",(0,n.jsx)(t.p,{children:"[2] Rasmus Pagha and Flemming Friche Rodler. Cuckoo hashing. Journal of Algorithms, 51(2), pp. 122-144, 2004."}),"\n",(0,n.jsx)(t.p,{children:"[3] Martin Dietzfelbinger and Christoph Weidling. Balanced Allocation and Dictionaries with Tightly Packed Constant Size Bins. Theoretical Computer Science, 380(1), pp. 47-68, 2007."}),"\n",(0,n.jsx)(t.p,{children:"[4] Paulo S. Almeida, Carlos Baquero, Nuno Pregui\xe7a, and David Hutchison. Scalable Bloom Filters. Information Processing Letters, 101(6), pp. 255-261, 2007."}),"\n",(0,n.jsx)(t.p,{children:"[5] John G. Cleary. Compact hash tables using bidirectional linear probing. IEEE Transactions on Computers. 33(9), pp. 828-834, 1984."}),"\n",(0,n.jsx)(t.p,{children:"[6] Anna Pagh, Rasmus Pagh, and S. Srinivasa Rao. An optimal Bloom filter replacement. Proceedings of the Sixteenth Annual ACM-SIAM Symposium on Discrete Algorithms, pp. 823-829, 2005."}),"\n",(0,n.jsx)(t.p,{children:"[7] Thomas Mueller Graf and Daniel Lemire. Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters. ACM Journal of Experimental Algorithmics. 25, pp. 1-16, 2020."})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},9969:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/bloom-79da0db687b4fb2060758838b9c44513.png"},5441:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/capacity-size-5c2576bd69db0e5b510781e7cc1c5257.png"},9844:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/fp-rate-size-fbb54b2450b4a91e28c97d8adf0253e8.png"},989:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/insert-3ff48d4c63724adcf399f81b29607691.png"},8915:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/lookup-e36011237d8602b5f6c36fe5dd145bf5.png"},9440:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/math-formul-a247d4df475b26b1e7cbb2acfc0ab8c2.png"},1151:(e,t,i)=>{i.d(t,{Z:()=>a,a:()=>s});var n=i(7294);const o={},r=n.createContext(o);function s(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7aefc753.93358e1b.js b/assets/js/7aefc753.5ad99947.js similarity index 99% rename from assets/js/7aefc753.93358e1b.js rename to assets/js/7aefc753.5ad99947.js index f42c863dd..b2bd1b50a 100644 --- a/assets/js/7aefc753.93358e1b.js +++ b/assets/js/7aefc753.5ad99947.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1251],{8717:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(5893),s=t(1151),l=t(3872);const r={title:"Uninstall Lightning Node",slug:"uninstall-lightning-node",hide_title:!0,tags:["References","Help","Uninstall","Remove","Delete","Clear","Clean"]},a=void 0,o={id:"Lightning CLI/uninstall-lightning-node",title:"Uninstall Lightning Node",description:"Remove symLink",source:"@site/references/Lightning CLI/uninstall-lightning-node.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/uninstall-lightning-node",permalink:"/references/Lightning CLI/uninstall-lightning-node",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/uninstall-lightning-node.md",tags:[{label:"References",permalink:"/references/tags/references"},{label:"Help",permalink:"/references/tags/help"},{label:"Uninstall",permalink:"/references/tags/uninstall"},{label:"Remove",permalink:"/references/tags/remove"},{label:"Delete",permalink:"/references/tags/delete"},{label:"Clear",permalink:"/references/tags/clear"},{label:"Clean",permalink:"/references/tags/clean"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Uninstall Lightning Node",slug:"uninstall-lightning-node",hide_title:!0,tags:["References","Help","Uninstall","Remove","Delete","Clear","Clean"]},sidebar:"defaultSidebar",previous:{title:"Restore the keystore",permalink:"/references/Lightning CLI/restore-the-keystore"},next:{title:"Update CLI from source code",permalink:"/references/Lightning CLI/update-cli-from-source-code"}},c={},d=[{value:"Remove symLink",id:"remove-symlink",level:2},{value:"Delete the local source code",id:"delete-the-local-source-code",level:2},{value:"Disable the systemd service",id:"disable-the-systemd-service",level:2},{value:"Clear the lightning config directory",id:"clear-the-lightning-config-directory",level:2},{value:"Uninstall Cargo and Rust",id:"uninstall-cargo-and-rust",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"remove-symlink",children:"Remove symLink"}),"\n",(0,i.jsxs)(n.p,{children:["To remove a symbolic link, use either the rm or unlink command followed by the name of the symlink as an argument. Here's an example with ",(0,i.jsx)(n.code,{children:"unlink"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"unlink /usr/local/bin/lgtn\n"})}),"\n",(0,i.jsx)(n.h2,{id:"delete-the-local-source-code",children:"Delete the local source code"}),"\n",(0,i.jsxs)(n.p,{children:["Delete the local source code which was copied from the remote ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"repository"}),". You can delete it recursively by:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/fleek-network/lightning\n"})}),"\n",(0,i.jsxs)(n.p,{children:["\ud83d\udca1 Use the flag ",(0,i.jsx)(n.code,{children:"f"})," to force remove by skipping any prompts, e.g. ",(0,i.jsx)(n.code,{children:"rm -rf "})]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["The default install location is ",(0,i.jsx)(n.code,{children:"$HOME/fleek-network/lightning"}),". If you have selected a different location to store the repository, change the target path."]})}),"\n",(0,i.jsx)(n.h2,{id:"disable-the-systemd-service",children:"Disable the systemd service"}),"\n",(0,i.jsx)(n.p,{children:"To disable the Fleek Network Lightning Systemd's service, start by stopping the service."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop lightning.service\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["You can replace ",(0,i.jsx)(n.code,{children:"lightning.service"})," by ",(0,i.jsx)(n.code,{children:"lightning"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"Disable the lightning service"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl disable lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have used the recommended procedures in the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install"})," documentation you'll have to remove the Systemd unit (file that defines the service)."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm /etc/systemd/system/lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Reload the Systemd service daemon"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsx)(n.h2,{id:"clear-the-lightning-config-directory",children:"Clear the lightning config directory"}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network lightning config directory is where the configuration, keystore\u2013the location where your private key is hosted\u2013and other system files are stored."}),"\n",(0,i.jsx)(n.admonition,{title:"WARNING",type:"caution",children:(0,i.jsx)(n.p,{children:"Make sure to back up any sensitive data, such as the keystore (private keys), as you won't be able to recover the keys by any other means. If you have any funds associated with it, it'll be lost forever. The Fleek Network team or anyone else will not be able to help recover keys. Your keys, your responsibility."})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, instead of deleting you can move the files to a custom directory name such as",(0,i.jsx)(n.code,{children:".lightning.backupDATESTAMP"}),", e.g. the example below we've used the date ",(0,i.jsx)(n.code,{children:"2023-09-06-1205"})," as that was the time this text was written:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"mv ~/.lightning ~/.lightning.backup202309061205\n"})}),"\n",(0,i.jsx)(n.p,{children:"To clear the lightning config directory remove any files recursively by running the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/.lightning/*\n"})}),"\n",(0,i.jsxs)(n.p,{children:["\ud83d\udca1 Use the flag ",(0,i.jsx)(n.code,{children:"f"})," to force remove by skipping any prompts, e.g. ",(0,i.jsx)(n.code,{children:"rm -rf /*"})]}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, delete the ",(0,i.jsx)(n.code,{children:"~/.lightning"})," directory:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/.lightning\n"})}),"\n",(0,i.jsx)(n.h2,{id:"uninstall-cargo-and-rust",children:"Uninstall Cargo and Rust"}),"\n",(0,i.jsx)(n.p,{children:"To uninstall rustc, rustup and cargo run the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rustup self uninstall\n"})}),"\n",(0,i.jsx)(l.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:l,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:l,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:l,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const s={},l=i.createContext(s);function r(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1251],{8717:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(5893),s=t(1151),l=t(3872);const r={title:"Uninstall Lightning Node",slug:"uninstall-lightning-node",hide_title:!0,tags:["References","Help","Uninstall","Remove","Delete","Clear","Clean"]},a=void 0,o={id:"Lightning CLI/uninstall-lightning-node",title:"Uninstall Lightning Node",description:"Remove symLink",source:"@site/references/Lightning CLI/uninstall-lightning-node.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/uninstall-lightning-node",permalink:"/references/Lightning CLI/uninstall-lightning-node",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/uninstall-lightning-node.md",tags:[{label:"References",permalink:"/references/tags/references"},{label:"Help",permalink:"/references/tags/help"},{label:"Uninstall",permalink:"/references/tags/uninstall"},{label:"Remove",permalink:"/references/tags/remove"},{label:"Delete",permalink:"/references/tags/delete"},{label:"Clear",permalink:"/references/tags/clear"},{label:"Clean",permalink:"/references/tags/clean"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Uninstall Lightning Node",slug:"uninstall-lightning-node",hide_title:!0,tags:["References","Help","Uninstall","Remove","Delete","Clear","Clean"]},sidebar:"defaultSidebar",previous:{title:"Restore the keystore",permalink:"/references/Lightning CLI/restore-the-keystore"},next:{title:"Update CLI from source code",permalink:"/references/Lightning CLI/update-cli-from-source-code"}},c={},d=[{value:"Remove symLink",id:"remove-symlink",level:2},{value:"Delete the local source code",id:"delete-the-local-source-code",level:2},{value:"Disable the systemd service",id:"disable-the-systemd-service",level:2},{value:"Clear the lightning config directory",id:"clear-the-lightning-config-directory",level:2},{value:"Uninstall Cargo and Rust",id:"uninstall-cargo-and-rust",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"remove-symlink",children:"Remove symLink"}),"\n",(0,i.jsxs)(n.p,{children:["To remove a symbolic link, use either the rm or unlink command followed by the name of the symlink as an argument. Here's an example with ",(0,i.jsx)(n.code,{children:"unlink"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"unlink /usr/local/bin/lgtn\n"})}),"\n",(0,i.jsx)(n.h2,{id:"delete-the-local-source-code",children:"Delete the local source code"}),"\n",(0,i.jsxs)(n.p,{children:["Delete the local source code which was copied from the remote ",(0,i.jsx)(n.a,{href:"https://github.com/fleek-network/lightning",children:"repository"}),". You can delete it recursively by:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/fleek-network/lightning\n"})}),"\n",(0,i.jsxs)(n.p,{children:["\ud83d\udca1 Use the flag ",(0,i.jsx)(n.code,{children:"f"})," to force remove by skipping any prompts, e.g. ",(0,i.jsx)(n.code,{children:"rm -rf "})]}),"\n",(0,i.jsx)(n.admonition,{type:"note",children:(0,i.jsxs)(n.p,{children:["The default install location is ",(0,i.jsx)(n.code,{children:"$HOME/fleek-network/lightning"}),". If you have selected a different location to store the repository, change the target path."]})}),"\n",(0,i.jsx)(n.h2,{id:"disable-the-systemd-service",children:"Disable the systemd service"}),"\n",(0,i.jsx)(n.p,{children:"To disable the Fleek Network Lightning Systemd's service, start by stopping the service."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop lightning.service\n"})}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["You can replace ",(0,i.jsx)(n.code,{children:"lightning.service"})," by ",(0,i.jsx)(n.code,{children:"lightning"}),"."]})}),"\n",(0,i.jsx)(n.p,{children:"Disable the lightning service"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl disable lightning.service\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you have used the recommended procedures in the ",(0,i.jsx)(n.a,{href:"/docs/node/install",children:"install"})," documentation you'll have to remove the Systemd unit (file that defines the service)."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm /etc/systemd/system/lightning.service\n"})}),"\n",(0,i.jsx)(n.p,{children:"Reload the Systemd service daemon"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,i.jsx)(n.h2,{id:"clear-the-lightning-config-directory",children:"Clear the lightning config directory"}),"\n",(0,i.jsx)(n.p,{children:"The Fleek Network lightning config directory is where the configuration, keystore\u2013the location where your private key is hosted\u2013and other system files are stored."}),"\n",(0,i.jsx)(n.admonition,{title:"WARNING",type:"caution",children:(0,i.jsx)(n.p,{children:"Make sure to back up any sensitive data, such as the keystore (private keys), as you won't be able to recover the keys by any other means. If you have any funds associated with it, it'll be lost forever. The Fleek Network team or anyone else will not be able to help recover keys. Your keys, your responsibility."})}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, instead of deleting you can move the files to a custom directory name such as",(0,i.jsx)(n.code,{children:".lightning.backupDATESTAMP"}),", e.g. the example below we've used the date ",(0,i.jsx)(n.code,{children:"2023-09-06-1205"})," as that was the time this text was written:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"mv ~/.lightning ~/.lightning.backup202309061205\n"})}),"\n",(0,i.jsx)(n.p,{children:"To clear the lightning config directory remove any files recursively by running the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/.lightning/*\n"})}),"\n",(0,i.jsxs)(n.p,{children:["\ud83d\udca1 Use the flag ",(0,i.jsx)(n.code,{children:"f"})," to force remove by skipping any prompts, e.g. ",(0,i.jsx)(n.code,{children:"rm -rf /*"})]}),"\n",(0,i.jsxs)(n.p,{children:["Alternatively, delete the ",(0,i.jsx)(n.code,{children:"~/.lightning"})," directory:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rm -r ~/.lightning\n"})}),"\n",(0,i.jsx)(n.h2,{id:"uninstall-cargo-and-rust",children:"Uninstall Cargo and Rust"}),"\n",(0,i.jsx)(n.p,{children:"To uninstall rustc, rustup and cargo run the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"rustup self uninstall\n"})}),"\n",(0,i.jsx)(l.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>s});t(7294);var i=t(5893);const s=e=>{let{image:n,name:t,title:s,url:l,communityMember:r=!1}=e;return(0,i.jsx)("section",{className:"author_card",children:(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"avatar",children:(0,i.jsx)("a",{href:l,target:"_blank",alt:t,children:(0,i.jsx)("img",{src:n,alt:t})})}),(0,i.jsxs)("div",{children:[(0,i.jsx)("span",{className:"name",children:(0,i.jsx)("a",{href:l,target:"_blank",alt:t,children:t})}),(0,i.jsx)("span",{className:"title",children:s}),(0,i.jsxs)("span",{className:"discord",children:[r?"Join our community on":"Got questions? Find us on"," ",(0,i.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(7294);const s={},l=i.createContext(s);function r(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/866d553a.db30cd0a.js b/assets/js/866d553a.8ce6bf03.js similarity index 99% rename from assets/js/866d553a.db30cd0a.js rename to assets/js/866d553a.8ce6bf03.js index 4fb5380a6..ecbeba234 100644 --- a/assets/js/866d553a.db30cd0a.js +++ b/assets/js/866d553a.8ce6bf03.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8668],{1534:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var t=s(5893),l=s(1151),i=s(3872);const a={title:"Frequently used commands for Native setup",slug:"frequently-used-commands-for-native-setup",hide_title:!0,tags:["commands","cli","lightning"]},r=void 0,d={id:"Lightning CLI/frequently-used-commands-for-native-setup",title:"Frequently used commands for Native setup",description:"TL;DR",source:"@site/references/Lightning CLI/frequently-used-commands-for-native-setup.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/frequently-used-commands-for-native-setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/frequently-used-commands-for-native-setup.md",tags:[{label:"commands",permalink:"/references/tags/commands"},{label:"cli",permalink:"/references/tags/cli"},{label:"lightning",permalink:"/references/tags/lightning"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Frequently used commands for Native setup",slug:"frequently-used-commands-for-native-setup",hide_title:!0,tags:["commands","cli","lightning"]},sidebar:"defaultSidebar",previous:{title:"File permissions and Ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership"},next:{title:"Keys not found",permalink:"/references/Lightning CLI/keys-not-found"}},c={},o=[{value:"TL;DR",id:"tldr",level:2},{value:"Systemctl Service Management",id:"systemctl-service-management",level:2},{value:"Enable",id:"enable",level:3},{value:"Disable",id:"disable",level:3},{value:"Start",id:"start",level:3},{value:"Stop",id:"stop",level:3},{value:"Restart",id:"restart",level:3},{value:"Status",id:"status",level:3},{value:"Lightning CLI",id:"lightning-cli",level:2},{value:"Show keys for user config",id:"show-keys-for-user-config",level:3},{value:"Diagnostic tools",id:"diagnostic-tools",level:2},{value:"Extended verification health check",id:"extended-verification-health-check",level:3},{value:"Health status",id:"health-status",level:3},{value:"Node details",id:"node-details",level:3},{value:"Analyzing Logs",id:"analyzing-logs",level:2},{value:"Standard output",id:"standard-output",level:3},{value:"Standard error",id:"standard-error",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,l.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.p,{children:["Most assisted processes are available through the ",(0,t.jsx)(n.code,{children:"get.fleek.network"})," command, where you can select to install, do a health check amongst others."]}),"\n",(0,t.jsx)(n.p,{children:"To access the menu options run the command in the shell prompt:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For Docker setup users read the corresponding version in the section ",(0,t.jsx)(n.a,{href:"/references/Docker/frequently-used-commands-for-docker-setup",children:"Frequently Used Commands for Docker Setup"})]})}),"\n",(0,t.jsx)(n.h2,{id:"systemctl-service-management",children:"Systemctl Service Management"}),"\n",(0,t.jsx)(n.h3,{id:"enable",children:"Enable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"disable",children:"Disable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop",children:"Stop"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"restart",children:"Restart"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl status lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"lightning-cli",children:"Lightning CLI"}),"\n",(0,t.jsx)(n.h3,{id:"show-keys-for-user-config",children:"Show keys for user config"}),"\n",(0,t.jsxs)(n.p,{children:["Show the keys by running the sub-commands ",(0,t.jsx)(n.code,{children:"keys show"})," and declaring the configuration file location:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home//.lightning/config.toml keys show\n"})}),"\n",(0,t.jsx)(n.h2,{id:"diagnostic-tools",children:"Diagnostic tools"}),"\n",(0,t.jsx)(n.h3,{id:"extended-verification-health-check",children:"Extended verification health check"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,t.jsx)(n.h3,{id:"health-status",children:"Health status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,t.jsx)(n.h3,{id:"node-details",children:"Node details"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/node_details | bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"analyzing-logs",children:"Analyzing Logs"}),"\n",(0,t.jsx)(n.h3,{id:"standard-output",children:"Standard output"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"standard-error",children:"Standard error"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>l});s(7294);var t=s(5893);const l=e=>{let{image:n,name:s,title:l,url:i,communityMember:a=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:i,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:i,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:l}),(0,t.jsxs)("span",{className:"discord",children:[a?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>a});var t=s(7294);const l={},i=t.createContext(l);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[8668],{1534:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var t=s(5893),l=s(1151),i=s(3872);const a={title:"Frequently used commands for Native setup",slug:"frequently-used-commands-for-native-setup",hide_title:!0,tags:["commands","cli","lightning"]},r=void 0,d={id:"Lightning CLI/frequently-used-commands-for-native-setup",title:"Frequently used commands for Native setup",description:"TL;DR",source:"@site/references/Lightning CLI/frequently-used-commands-for-native-setup.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/frequently-used-commands-for-native-setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/frequently-used-commands-for-native-setup.md",tags:[{label:"commands",permalink:"/references/tags/commands"},{label:"cli",permalink:"/references/tags/cli"},{label:"lightning",permalink:"/references/tags/lightning"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Frequently used commands for Native setup",slug:"frequently-used-commands-for-native-setup",hide_title:!0,tags:["commands","cli","lightning"]},sidebar:"defaultSidebar",previous:{title:"File permissions and Ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership"},next:{title:"Keys not found",permalink:"/references/Lightning CLI/keys-not-found"}},c={},o=[{value:"TL;DR",id:"tldr",level:2},{value:"Systemctl Service Management",id:"systemctl-service-management",level:2},{value:"Enable",id:"enable",level:3},{value:"Disable",id:"disable",level:3},{value:"Start",id:"start",level:3},{value:"Stop",id:"stop",level:3},{value:"Restart",id:"restart",level:3},{value:"Status",id:"status",level:3},{value:"Lightning CLI",id:"lightning-cli",level:2},{value:"Show keys for user config",id:"show-keys-for-user-config",level:3},{value:"Diagnostic tools",id:"diagnostic-tools",level:2},{value:"Extended verification health check",id:"extended-verification-health-check",level:3},{value:"Health status",id:"health-status",level:3},{value:"Node details",id:"node-details",level:3},{value:"Analyzing Logs",id:"analyzing-logs",level:2},{value:"Standard output",id:"standard-output",level:3},{value:"Standard error",id:"standard-error",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,l.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.p,{children:["Most assisted processes are available through the ",(0,t.jsx)(n.code,{children:"get.fleek.network"})," command, where you can select to install, do a health check amongst others."]}),"\n",(0,t.jsx)(n.p,{children:"To access the menu options run the command in the shell prompt:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For Docker setup users read the corresponding version in the section ",(0,t.jsx)(n.a,{href:"/references/Docker/frequently-used-commands-for-docker-setup",children:"Frequently Used Commands for Docker Setup"})]})}),"\n",(0,t.jsx)(n.h2,{id:"systemctl-service-management",children:"Systemctl Service Management"}),"\n",(0,t.jsx)(n.h3,{id:"enable",children:"Enable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"disable",children:"Disable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop",children:"Stop"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"restart",children:"Restart"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl status lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"lightning-cli",children:"Lightning CLI"}),"\n",(0,t.jsx)(n.h3,{id:"show-keys-for-user-config",children:"Show keys for user config"}),"\n",(0,t.jsxs)(n.p,{children:["Show the keys by running the sub-commands ",(0,t.jsx)(n.code,{children:"keys show"})," and declaring the configuration file location:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lgtn -c /home//.lightning/config.toml keys show\n"})}),"\n",(0,t.jsx)(n.h2,{id:"diagnostic-tools",children:"Diagnostic tools"}),"\n",(0,t.jsx)(n.h3,{id:"extended-verification-health-check",children:"Extended verification health check"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,t.jsx)(n.h3,{id:"health-status",children:"Health status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,t.jsx)(n.h3,{id:"node-details",children:"Node details"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/node_details | bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"analyzing-logs",children:"Analyzing Logs"}),"\n",(0,t.jsx)(n.h3,{id:"standard-output",children:"Standard output"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"standard-error",children:"Standard error"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>l});s(7294);var t=s(5893);const l=e=>{let{image:n,name:s,title:l,url:i,communityMember:a=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:i,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:i,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:l}),(0,t.jsxs)("span",{className:"discord",children:[a?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>a});var t=s(7294);const l={},i=t.createContext(l);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a92e787.00004987.js b/assets/js/8a92e787.69bc4b07.js similarity index 99% rename from assets/js/8a92e787.00004987.js rename to assets/js/8a92e787.69bc4b07.js index a10b6cbb5..3aa214011 100644 --- a/assets/js/8a92e787.00004987.js +++ b/assets/js/8a92e787.69bc4b07.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2517],{6739:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var t=n(5893),r=n(1151),o=n(3872);const i={title:"Shutting down persistance",slug:"shutting-down-persistance",hide_title:!0,tags:["reference","shutdown","frozen","idle","service error","systemctl","systemd"]},c=void 0,l={id:"Systemd/shutting-down-persistance",title:"Shutting down persistance",description:"Systemd Service as frozen or idle",source:"@site/references/Systemd/shutting-down-persistance.md",sourceDirName:"Systemd",slug:"/Systemd/shutting-down-persistance",permalink:"/references/Systemd/shutting-down-persistance",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/shutting-down-persistance.md",tags:[{label:"reference",permalink:"/references/tags/reference"},{label:"shutdown",permalink:"/references/tags/shutdown"},{label:"frozen",permalink:"/references/tags/frozen"},{label:"idle",permalink:"/references/tags/idle"},{label:"service error",permalink:"/references/tags/service-error"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Shutting down persistance",slug:"shutting-down-persistance",hide_title:!0,tags:["reference","shutdown","frozen","idle","service error","systemctl","systemd"]},sidebar:"defaultSidebar",previous:{title:"Service keeps running after shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown"},next:{title:"User service",permalink:"/references/Systemd/user-service"}},a={},d=[{value:"Systemd Service as frozen or idle",id:"systemd-service-as-frozen-or-idle",level:2}];function h(e){const s={code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h2,{id:"systemd-service-as-frozen-or-idle",children:"Systemd Service as frozen or idle"}),"\n",(0,t.jsxs)(s.p,{children:["If you have a ",(0,t.jsx)(s.code,{children:"Shutting node down"})," message on the service log, the process is likely failing to respond to Systemd shut down command by failing to terminate all the child processes that were started by the service."]}),"\n",(0,t.jsx)(s.p,{children:"The logs should be similar to the following:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"2023-09-11 18:02:07 | ERROR | lightning_consensus::consensus - core/consensus/src/consensus.rs:371 - node: XsE9KtedDRUGv22MLHvy8qcc52QsWGWJYY1LBnWhglg=\n2023-09-11 18:02:07 | ERROR | lightning_consensus::consensus - core/consensus/src/consensus.rs:371 - node: zBmZaycvQsdFRfe0p5Rig/KgyYPD4yNKQTPDo7JrugM=\n2023-09-11 18:02:07 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:373 - ##################\n2023-09-11 18:02:07 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:374 - ********************************\nRPC server starting up\nlistening on 0.0.0.0:4230\nShutting node down.\nShutting node down.\nShutting node down.\nShutting node down.\nShutting node down.\n"})}),"\n",(0,t.jsxs)(s.p,{children:["To resolve this issue, start by executing a new ",(0,t.jsx)(s.code,{children:"shutdown"})," command as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"systemctl stop lightning\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you need to delegate to root, then use the ",(0,t.jsx)(s.strong,{children:"sudo"})," keyword, as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,t.jsx)(s.p,{children:"Once completed, clear the logs to avoid confusion as the log aggregates messages past and current."}),"\n",(0,t.jsx)(s.p,{children:"Delete all the log files (output.log and diagnostic.log) by running:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo rm -f /var/log/lightning/*.log\n"})}),"\n",(0,t.jsx)(s.p,{children:"Launch the service:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"systemctl start lightning\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you need to delegate to root, then use the ",(0,t.jsx)(s.strong,{children:"sudo"})," keyword, as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo systemctl start lightning\n"})}),"\n",(0,t.jsx)(s.p,{children:"You can watch the log output of the service by running:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(s.p,{children:"The output should be similar to:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"2023-09-12 13:53:51 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:373 - ##################\n2023-09-12 13:53:51 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:374 - ********************************\n"})}),"\n",(0,t.jsx)(s.p,{children:"Alternatively, you can watch the diagnostic.log"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,s,n)=>{n.d(s,{Z:()=>r});n(7294);var t=n(5893);const r=e=>{let{image:s,name:n,title:r,url:o,communityMember:i=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:n,children:(0,t.jsx)("img",{src:s,alt:n})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:n,children:n})}),(0,t.jsx)("span",{className:"title",children:r}),(0,t.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var t=n(7294);const r={},o=t.createContext(r);function i(e){const s=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2517],{6739:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var t=n(5893),r=n(1151),o=n(3872);const i={title:"Shutting down persistance",slug:"shutting-down-persistance",hide_title:!0,tags:["reference","shutdown","frozen","idle","service error","systemctl","systemd"]},c=void 0,l={id:"Systemd/shutting-down-persistance",title:"Shutting down persistance",description:"Systemd Service as frozen or idle",source:"@site/references/Systemd/shutting-down-persistance.md",sourceDirName:"Systemd",slug:"/Systemd/shutting-down-persistance",permalink:"/references/Systemd/shutting-down-persistance",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/shutting-down-persistance.md",tags:[{label:"reference",permalink:"/references/tags/reference"},{label:"shutdown",permalink:"/references/tags/shutdown"},{label:"frozen",permalink:"/references/tags/frozen"},{label:"idle",permalink:"/references/tags/idle"},{label:"service error",permalink:"/references/tags/service-error"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Shutting down persistance",slug:"shutting-down-persistance",hide_title:!0,tags:["reference","shutdown","frozen","idle","service error","systemctl","systemd"]},sidebar:"defaultSidebar",previous:{title:"Service keeps running after shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown"},next:{title:"User service",permalink:"/references/Systemd/user-service"}},a={},d=[{value:"Systemd Service as frozen or idle",id:"systemd-service-as-frozen-or-idle",level:2}];function h(e){const s={code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h2,{id:"systemd-service-as-frozen-or-idle",children:"Systemd Service as frozen or idle"}),"\n",(0,t.jsxs)(s.p,{children:["If you have a ",(0,t.jsx)(s.code,{children:"Shutting node down"})," message on the service log, the process is likely failing to respond to Systemd shut down command by failing to terminate all the child processes that were started by the service."]}),"\n",(0,t.jsx)(s.p,{children:"The logs should be similar to the following:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"2023-09-11 18:02:07 | ERROR | lightning_consensus::consensus - core/consensus/src/consensus.rs:371 - node: XsE9KtedDRUGv22MLHvy8qcc52QsWGWJYY1LBnWhglg=\n2023-09-11 18:02:07 | ERROR | lightning_consensus::consensus - core/consensus/src/consensus.rs:371 - node: zBmZaycvQsdFRfe0p5Rig/KgyYPD4yNKQTPDo7JrugM=\n2023-09-11 18:02:07 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:373 - ##################\n2023-09-11 18:02:07 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:374 - ********************************\nRPC server starting up\nlistening on 0.0.0.0:4230\nShutting node down.\nShutting node down.\nShutting node down.\nShutting node down.\nShutting node down.\n"})}),"\n",(0,t.jsxs)(s.p,{children:["To resolve this issue, start by executing a new ",(0,t.jsx)(s.code,{children:"shutdown"})," command as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"systemctl stop lightning\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you need to delegate to root, then use the ",(0,t.jsx)(s.strong,{children:"sudo"})," keyword, as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,t.jsx)(s.p,{children:"Once completed, clear the logs to avoid confusion as the log aggregates messages past and current."}),"\n",(0,t.jsx)(s.p,{children:"Delete all the log files (output.log and diagnostic.log) by running:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo rm -f /var/log/lightning/*.log\n"})}),"\n",(0,t.jsx)(s.p,{children:"Launch the service:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"systemctl start lightning\n"})}),"\n",(0,t.jsxs)(s.p,{children:["If you need to delegate to root, then use the ",(0,t.jsx)(s.strong,{children:"sudo"})," keyword, as follows:"]}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"sudo systemctl start lightning\n"})}),"\n",(0,t.jsx)(s.p,{children:"You can watch the log output of the service by running:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(s.p,{children:"The output should be similar to:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"2023-09-12 13:53:51 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:373 - ##################\n2023-09-12 13:53:51 | WARN | lightning_consensus::consensus - core/consensus/src/consensus.rs:374 - ********************************\n"})}),"\n",(0,t.jsx)(s.p,{children:"Alternatively, you can watch the diagnostic.log"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,s,n)=>{n.d(s,{Z:()=>r});n(7294);var t=n(5893);const r=e=>{let{image:s,name:n,title:r,url:o,communityMember:i=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:n,children:(0,t.jsx)("img",{src:s,alt:n})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:n,children:n})}),(0,t.jsx)("span",{className:"title",children:r}),(0,t.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var t=n(7294);const r={},o=t.createContext(r);function i(e){const s=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9722e053.1c14cb03.js b/assets/js/9722e053.ea8653ae.js similarity index 99% rename from assets/js/9722e053.1c14cb03.js rename to assets/js/9722e053.ea8653ae.js index 0e045dd65..73eaff6af 100644 --- a/assets/js/9722e053.1c14cb03.js +++ b/assets/js/9722e053.ea8653ae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1955],{6410:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>o});var t=s(5893),r=s(1151),a=s(3872);const l={title:"Frequently used commands for Docker setup",slug:"frequently-used-commands-for-docker-setup",hide_title:!0,tags:["commands","cli","lightning","docker"]},i=void 0,c={id:"Docker/frequently-used-commands-for-docker-setup",title:"Frequently used commands for Docker setup",description:"TL;DR",source:"@site/references/Docker/frequently-used-commands-for-docker-setup.md",sourceDirName:"Docker",slug:"/Docker/frequently-used-commands-for-docker-setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/frequently-used-commands-for-docker-setup.md",tags:[{label:"commands",permalink:"/references/tags/commands"},{label:"cli",permalink:"/references/tags/cli"},{label:"lightning",permalink:"/references/tags/lightning"},{label:"docker",permalink:"/references/tags/docker"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Frequently used commands for Docker setup",slug:"frequently-used-commands-for-docker-setup",hide_title:!0,tags:["commands","cli","lightning","docker"]},sidebar:"defaultSidebar",previous:{title:"Build and run in Docker",permalink:"/references/Docker/build-and-run-in-docker"},next:{title:"Uninstall Docker Setup",permalink:"/references/Docker/uninstall-docker-setup"}},d={},o=[{value:"TL;DR",id:"tldr",level:2},{value:"Systemctl Service Management",id:"systemctl-service-management",level:2},{value:"Enable",id:"enable",level:3},{value:"Disable",id:"disable",level:3},{value:"Start",id:"start",level:3},{value:"Stop",id:"stop",level:3},{value:"Restart",id:"restart",level:3},{value:"Status",id:"status",level:3},{value:"Lightning CLI via Docker",id:"lightning-cli-via-docker",level:2},{value:"Show keys for user config",id:"show-keys-for-user-config",level:3},{value:"Diagnostic tools",id:"diagnostic-tools",level:2},{value:"Extended verification health check",id:"extended-verification-health-check",level:3},{value:"Health status",id:"health-status",level:3},{value:"Node details",id:"node-details",level:3},{value:"Analyzing Logs",id:"analyzing-logs",level:2},{value:"Standard output",id:"standard-output",level:3},{value:"Standard error",id:"standard-error",level:3},{value:"Docker Container Logs",id:"docker-container-logs",level:3},{value:"Interactive Container",id:"interactive-container",level:2},{value:"Execute Bash",id:"execute-bash",level:3},{value:"Docker",id:"docker",level:2},{value:"List Containers",id:"list-containers",level:3},{value:"Start Container",id:"start-container",level:3},{value:"Stop Container",id:"stop-container",level:3},{value:"Remove Container",id:"remove-container",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.p,{children:["Most assisted processes are available through the ",(0,t.jsx)(n.code,{children:"get.fleek.network"})," command, where you can select to install, do a health check amongst others."]}),"\n",(0,t.jsx)(n.p,{children:"To access the menu options run the command in the shell prompt:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For Native setup users read the corresponding version in the section ",(0,t.jsx)(n.a,{href:"/references/Lightning%20CLI/frequently-used-commands-for-native-setup",children:"Frequently Used Commands for Native Setup"})]})}),"\n",(0,t.jsx)(n.h2,{id:"systemctl-service-management",children:"Systemctl Service Management"}),"\n",(0,t.jsx)(n.h3,{id:"enable",children:"Enable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"disable",children:"Disable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop",children:"Stop"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"restart",children:"Restart"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl status docker-lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"lightning-cli-via-docker",children:"Lightning CLI via Docker"}),"\n",(0,t.jsx)(n.h3,{id:"show-keys-for-user-config",children:"Show keys for user config"}),"\n",(0,t.jsxs)(n.p,{children:["Show the keys by running the sub-commands ",(0,t.jsx)(n.code,{children:"keys show"})," and declaring the configuration file location (in-docker pathname):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn -c /home/lgtn/.lightning/config.toml keys show\n"})}),"\n",(0,t.jsx)(n.h2,{id:"diagnostic-tools",children:"Diagnostic tools"}),"\n",(0,t.jsx)(n.h3,{id:"extended-verification-health-check",children:"Extended verification health check"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,t.jsx)(n.h3,{id:"health-status",children:"Health status"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,t.jsx)(n.h3,{id:"node-details",children:"Node details"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/node_details | bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"analyzing-logs",children:"Analyzing Logs"}),"\n",(0,t.jsx)(n.h3,{id:"standard-output",children:"Standard output"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"standard-error",children:"Standard error"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"docker-container-logs",children:"Docker Container Logs"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,t.jsx)(n.h2,{id:"interactive-container",children:"Interactive Container"}),"\n",(0,t.jsx)(n.h3,{id:"execute-bash",children:"Execute Bash"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker",children:"Docker"}),"\n",(0,t.jsx)(n.h3,{id:"list-containers",children:"List Containers"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker ps -a\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start-container",children:"Start Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker start \n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop-container",children:"Stop Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker stop \n"})}),"\n",(0,t.jsx)(n.h3,{id:"remove-container",children:"Remove Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker rm \n"})}),"\n",(0,t.jsx)(a.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>r});s(7294);var t=s(5893);const r=e=>{let{image:n,name:s,title:r,url:a,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:a,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:a,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:r}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>l});var t=s(7294);const r={},a=t.createContext(r);function l(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1955],{6410:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>o});var t=s(5893),r=s(1151),a=s(3872);const l={title:"Frequently used commands for Docker setup",slug:"frequently-used-commands-for-docker-setup",hide_title:!0,tags:["commands","cli","lightning","docker"]},i=void 0,c={id:"Docker/frequently-used-commands-for-docker-setup",title:"Frequently used commands for Docker setup",description:"TL;DR",source:"@site/references/Docker/frequently-used-commands-for-docker-setup.md",sourceDirName:"Docker",slug:"/Docker/frequently-used-commands-for-docker-setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/frequently-used-commands-for-docker-setup.md",tags:[{label:"commands",permalink:"/references/tags/commands"},{label:"cli",permalink:"/references/tags/cli"},{label:"lightning",permalink:"/references/tags/lightning"},{label:"docker",permalink:"/references/tags/docker"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Frequently used commands for Docker setup",slug:"frequently-used-commands-for-docker-setup",hide_title:!0,tags:["commands","cli","lightning","docker"]},sidebar:"defaultSidebar",previous:{title:"Build and run in Docker",permalink:"/references/Docker/build-and-run-in-docker"},next:{title:"Uninstall Docker Setup",permalink:"/references/Docker/uninstall-docker-setup"}},d={},o=[{value:"TL;DR",id:"tldr",level:2},{value:"Systemctl Service Management",id:"systemctl-service-management",level:2},{value:"Enable",id:"enable",level:3},{value:"Disable",id:"disable",level:3},{value:"Start",id:"start",level:3},{value:"Stop",id:"stop",level:3},{value:"Restart",id:"restart",level:3},{value:"Status",id:"status",level:3},{value:"Lightning CLI via Docker",id:"lightning-cli-via-docker",level:2},{value:"Show keys for user config",id:"show-keys-for-user-config",level:3},{value:"Diagnostic tools",id:"diagnostic-tools",level:2},{value:"Extended verification health check",id:"extended-verification-health-check",level:3},{value:"Health status",id:"health-status",level:3},{value:"Node details",id:"node-details",level:3},{value:"Analyzing Logs",id:"analyzing-logs",level:2},{value:"Standard output",id:"standard-output",level:3},{value:"Standard error",id:"standard-error",level:3},{value:"Docker Container Logs",id:"docker-container-logs",level:3},{value:"Interactive Container",id:"interactive-container",level:2},{value:"Execute Bash",id:"execute-bash",level:3},{value:"Docker",id:"docker",level:2},{value:"List Containers",id:"list-containers",level:3},{value:"Start Container",id:"start-container",level:3},{value:"Stop Container",id:"stop-container",level:3},{value:"Remove Container",id:"remove-container",level:3}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"tldr",children:"TL;DR"}),"\n",(0,t.jsxs)(n.p,{children:["Most assisted processes are available through the ",(0,t.jsx)(n.code,{children:"get.fleek.network"})," command, where you can select to install, do a health check amongst others."]}),"\n",(0,t.jsx)(n.p,{children:"To access the menu options run the command in the shell prompt:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["For Native setup users read the corresponding version in the section ",(0,t.jsx)(n.a,{href:"/references/Lightning%20CLI/frequently-used-commands-for-native-setup",children:"Frequently Used Commands for Native Setup"})]})}),"\n",(0,t.jsx)(n.h2,{id:"systemctl-service-management",children:"Systemctl Service Management"}),"\n",(0,t.jsx)(n.h3,{id:"enable",children:"Enable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"disable",children:"Disable"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl enable docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl start docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop",children:"Stop"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl stop docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"restart",children:"Restart"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl restart docker-lightning\n"})}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo systemctl status docker-lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"lightning-cli-via-docker",children:"Lightning CLI via Docker"}),"\n",(0,t.jsx)(n.h3,{id:"show-keys-for-user-config",children:"Show keys for user config"}),"\n",(0,t.jsxs)(n.p,{children:["Show the keys by running the sub-commands ",(0,t.jsx)(n.code,{children:"keys show"})," and declaring the configuration file location (in-docker pathname):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn -c /home/lgtn/.lightning/config.toml keys show\n"})}),"\n",(0,t.jsx)(n.h2,{id:"diagnostic-tools",children:"Diagnostic tools"}),"\n",(0,t.jsx)(n.h3,{id:"extended-verification-health-check",children:"Extended verification health check"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/healthcheck | bash\n"})}),"\n",(0,t.jsx)(n.h3,{id:"health-status",children:"Health status"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'curl -w "\\n" localhost:4230/health\n'})}),"\n",(0,t.jsx)(n.h3,{id:"node-details",children:"Node details"}),"\n",(0,t.jsx)(n.p,{children:"The command show be executed from host and not in-Docker container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -sS https://get.fleek.network/node_details | bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"analyzing-logs",children:"Analyzing Logs"}),"\n",(0,t.jsx)(n.h3,{id:"standard-output",children:"Standard output"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/output.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"standard-error",children:"Standard error"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"tail -f /var/log/lightning/diagnostic.log\n"})}),"\n",(0,t.jsx)(n.h3,{id:"docker-container-logs",children:"Docker Container Logs"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,t.jsx)(n.h2,{id:"interactive-container",children:"Interactive Container"}),"\n",(0,t.jsx)(n.h3,{id:"execute-bash",children:"Execute Bash"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node bash\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker",children:"Docker"}),"\n",(0,t.jsx)(n.h3,{id:"list-containers",children:"List Containers"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker ps -a\n"})}),"\n",(0,t.jsx)(n.h3,{id:"start-container",children:"Start Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker start \n"})}),"\n",(0,t.jsx)(n.h3,{id:"stop-container",children:"Stop Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker stop \n"})}),"\n",(0,t.jsx)(n.h3,{id:"remove-container",children:"Remove Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker rm \n"})}),"\n",(0,t.jsx)(a.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,s)=>{s.d(n,{Z:()=>r});s(7294);var t=s(5893);const r=e=>{let{image:n,name:s,title:r,url:a,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:a,target:"_blank",alt:s,children:(0,t.jsx)("img",{src:n,alt:s})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:a,target:"_blank",alt:s,children:s})}),(0,t.jsx)("span",{className:"title",children:r}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>l});var t=s(7294);const r={},a=t.createContext(r);function l(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98f9308d.90313cd9.js b/assets/js/98f9308d.51072b62.js similarity index 98% rename from assets/js/98f9308d.90313cd9.js rename to assets/js/98f9308d.51072b62.js index 218d6aeeb..0698a0bdd 100644 --- a/assets/js/98f9308d.90313cd9.js +++ b/assets/js/98f9308d.51072b62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1025],{2150:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var n=t(5893),r=t(1151),i=t(3872);const c={title:"Service keeps running after shutdown",slug:"service-keeps-running-after-shutdown",hide_title:!0,tags:["reference","shutdown","systemctl","systemd","pkill","process"]},l=void 0,o={id:"Systemd/service-keeps-running-after-shutdown",title:"Service keeps running after shutdown",description:"Stop the service",source:"@site/references/Systemd/service-keeps-running-after-shutdown.md",sourceDirName:"Systemd",slug:"/Systemd/service-keeps-running-after-shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/service-keeps-running-after-shutdown.md",tags:[{label:"reference",permalink:"/references/tags/reference"},{label:"shutdown",permalink:"/references/tags/shutdown"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"},{label:"pkill",permalink:"/references/tags/pkill"},{label:"process",permalink:"/references/tags/process"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Service keeps running after shutdown",slug:"service-keeps-running-after-shutdown",hide_title:!0,tags:["reference","shutdown","systemctl","systemd","pkill","process"]},sidebar:"defaultSidebar",previous:{title:"Update CLI from source code",permalink:"/references/Lightning CLI/update-cli-from-source-code"},next:{title:"Shutting down persistance",permalink:"/references/Systemd/shutting-down-persistance"}},a={},d=[{value:"Stop the service",id:"stop-the-service",level:2},{value:"Kill the process by name",id:"kill-the-process-by-name",level:2}];function h(e){const s={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h2,{id:"stop-the-service",children:"Stop the service"}),"\n",(0,n.jsxs)(s.p,{children:["The ",(0,n.jsx)(s.a,{href:"/docs/node/systemd-service",children:"Systemd service"})," section tells how to stop the service, as follows:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Although, the service is set to restart on failure after a few seconds."}),"\n",(0,n.jsx)(s.h2,{id:"kill-the-process-by-name",children:"Kill the process by name"}),"\n",(0,n.jsxs)(s.p,{children:["Force stop a process by name with the command ",(0,n.jsx)(s.code,{children:"pkill"}),"."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"pkill -f \n"})}),"\n",(0,n.jsxs)(s.p,{children:["If you've followed the recommended settings, or used the assisted installer the process should be called ",(0,n.jsx)(s.code,{children:"lgtn"}),"."]}),"\n",(0,n.jsxs)(s.p,{children:["A Systemd service is managed by ",(0,n.jsx)(s.a,{href:"/docs/node/systemd-service",children:"Systemctl"}),", to start, stop, to get status or restart. The service controls the Lightning CLI service, that for our convenience named as ",(0,n.jsx)(s.code,{children:"lgtn"}),"\u2013short for lightning. If you haven't followed the recommended settings and have a custom set up, you need to use the custom details you have defined."]}),"\n",(0,n.jsxs)(s.p,{children:["To force stop the service ",(0,n.jsx)(s.code,{children:"lgtn"})," execute the command:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo killall -9 lgtn\n"})}),"\n",(0,n.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,s,t)=>{t.d(s,{Z:()=>r});t(7294);var n=t(5893);const r=e=>{let{image:s,name:t,title:r,url:i,communityMember:c=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,n.jsx)("img",{src:s,alt:t})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,n.jsx)("span",{className:"title",children:r}),(0,n.jsxs)("span",{className:"discord",children:[c?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,t)=>{t.d(s,{Z:()=>l,a:()=>c});var n=t(7294);const r={},i=n.createContext(r);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1025],{2150:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var n=t(5893),r=t(1151),i=t(3872);const c={title:"Service keeps running after shutdown",slug:"service-keeps-running-after-shutdown",hide_title:!0,tags:["reference","shutdown","systemctl","systemd","pkill","process"]},l=void 0,o={id:"Systemd/service-keeps-running-after-shutdown",title:"Service keeps running after shutdown",description:"Stop the service",source:"@site/references/Systemd/service-keeps-running-after-shutdown.md",sourceDirName:"Systemd",slug:"/Systemd/service-keeps-running-after-shutdown",permalink:"/references/Systemd/service-keeps-running-after-shutdown",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/service-keeps-running-after-shutdown.md",tags:[{label:"reference",permalink:"/references/tags/reference"},{label:"shutdown",permalink:"/references/tags/shutdown"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"},{label:"pkill",permalink:"/references/tags/pkill"},{label:"process",permalink:"/references/tags/process"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Service keeps running after shutdown",slug:"service-keeps-running-after-shutdown",hide_title:!0,tags:["reference","shutdown","systemctl","systemd","pkill","process"]},sidebar:"defaultSidebar",previous:{title:"Update CLI from source code",permalink:"/references/Lightning CLI/update-cli-from-source-code"},next:{title:"Shutting down persistance",permalink:"/references/Systemd/shutting-down-persistance"}},a={},d=[{value:"Stop the service",id:"stop-the-service",level:2},{value:"Kill the process by name",id:"kill-the-process-by-name",level:2}];function h(e){const s={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h2,{id:"stop-the-service",children:"Stop the service"}),"\n",(0,n.jsxs)(s.p,{children:["The ",(0,n.jsx)(s.a,{href:"/docs/node/systemd-service",children:"Systemd service"})," section tells how to stop the service, as follows:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo systemctl stop lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Although, the service is set to restart on failure after a few seconds."}),"\n",(0,n.jsx)(s.h2,{id:"kill-the-process-by-name",children:"Kill the process by name"}),"\n",(0,n.jsxs)(s.p,{children:["Force stop a process by name with the command ",(0,n.jsx)(s.code,{children:"pkill"}),"."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"pkill -f \n"})}),"\n",(0,n.jsxs)(s.p,{children:["If you've followed the recommended settings, or used the assisted installer the process should be called ",(0,n.jsx)(s.code,{children:"lgtn"}),"."]}),"\n",(0,n.jsxs)(s.p,{children:["A Systemd service is managed by ",(0,n.jsx)(s.a,{href:"/docs/node/systemd-service",children:"Systemctl"}),", to start, stop, to get status or restart. The service controls the Lightning CLI service, that for our convenience named as ",(0,n.jsx)(s.code,{children:"lgtn"}),"\u2013short for lightning. If you haven't followed the recommended settings and have a custom set up, you need to use the custom details you have defined."]}),"\n",(0,n.jsxs)(s.p,{children:["To force stop the service ",(0,n.jsx)(s.code,{children:"lgtn"})," execute the command:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo killall -9 lgtn\n"})}),"\n",(0,n.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,s,t)=>{t.d(s,{Z:()=>r});t(7294);var n=t(5893);const r=e=>{let{image:s,name:t,title:r,url:i,communityMember:c=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,n.jsx)("img",{src:s,alt:t})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,n.jsx)("span",{className:"title",children:r}),(0,n.jsxs)("span",{className:"discord",children:[c?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,t)=>{t.d(s,{Z:()=>l,a:()=>c});var n=t(7294);const r={},i=n.createContext(r);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b249ed45.56c5c530.js b/assets/js/b249ed45.401d8f19.js similarity index 99% rename from assets/js/b249ed45.56c5c530.js rename to assets/js/b249ed45.401d8f19.js index 62e3eb001..2fc78893d 100644 --- a/assets/js/b249ed45.56c5c530.js +++ b/assets/js/b249ed45.401d8f19.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[5767],{3183:(e,n,t)=>{t.d(n,{ZP:()=>s});var r=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,r.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,r.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,r.jsxs)(n.li,{children:["Download the ",(0,r.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,r.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,r.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,r.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function s(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(i,{...e})}):i(e)}},1583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var r=t(5893),o=t(1151),i=t(3872);t(3183);const s={title:"Uninstall Docker Setup",slug:"uninstall-docker-setup",hide_title:!0,tags:["references","help","docker","image","container"]},c=void 0,l={id:"Docker/uninstall-docker-setup",title:"Uninstall Docker Setup",description:"Remove the source code locally",source:"@site/references/Docker/uninstall-docker-setup.md",sourceDirName:"Docker",slug:"/Docker/uninstall-docker-setup",permalink:"/references/Docker/uninstall-docker-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/uninstall-docker-setup.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"docker",permalink:"/references/tags/docker"},{label:"image",permalink:"/references/tags/image"},{label:"container",permalink:"/references/tags/container"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Uninstall Docker Setup",slug:"uninstall-docker-setup",hide_title:!0,tags:["references","help","docker","image","container"]},sidebar:"defaultSidebar",previous:{title:"Frequently used commands for Docker setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup"},next:{title:"Error building on ARM64",permalink:"/references/Lightning CLI/error-building-on-arm64"}},a={},d=[{value:"Remove the source code locally",id:"remove-the-source-code-locally",level:2},{value:"Stop the Docker service",id:"stop-the-docker-service",level:2},{value:"Confirm the Docker service status",id:"confirm-the-docker-service-status",level:2},{value:"Reload the daemon",id:"reload-the-daemon",level:2},{value:"Remove the Systemd Service Unit file",id:"remove-the-systemd-service-unit-file",level:2},{value:"Delete the Docker image",id:"delete-the-docker-image",level:2},{value:"Uninstall Docker",id:"uninstall-docker",level:2},{value:"Manage keys",id:"manage-keys",level:2},{value:"Remove the logs",id:"remove-the-logs",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"remove-the-source-code-locally",children:"Remove the source code locally"}),"\n",(0,r.jsx)(n.p,{children:"For users who build the Docker image from source-code."}),"\n",(0,r.jsxs)(n.p,{children:["Assuming the default installation source-code path ",(0,r.jsx)(n.code,{children:"~/fleek-network/lightning"}),", run the command:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"rm -rf ~/fleek-network/lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"If you have a custom path, you need to change the pathname to the correct path you have selected during your custom install."}),"\n",(0,r.jsx)(n.h2,{id:"stop-the-docker-service",children:"Stop the Docker service"}),"\n",(0,r.jsx)(n.p,{children:"The Fleek Network recommends systemctl to manage the services, either natively or docker. It's an interface that is easily to translate across the setups, and to communicate to the users in a common manner."}),"\n",(0,r.jsx)(n.p,{children:"If you have followed the recommendations, you should have the Systemd Unit Service setup."}),"\n",(0,r.jsx)(n.p,{children:"To stop the service run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl stop docker-lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"confirm-the-docker-service-status",children:"Confirm the Docker service status"}),"\n",(0,r.jsx)(n.p,{children:"Check the status by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl status docker-lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"Disable the service by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl disable docker-lightning\n"})}),"\n",(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsxs)(n.p,{children:["Once stop, you can run the following command to confirm it is not running. If you have used the recommended container name ",(0,r.jsx)(n.code,{children:"lightning-node"})," the command you'd have to execute is:"]}),(0,r.jsxs)(n.p,{children:["You can check the Docker container isn't running by running the following command. Notice that we are assuming that your docker container name is the default ",(0,r.jsx)(n.code,{children:"lightning-node"}),". If you have customized the name use the correct selected name:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo docker container inspect -f '{{.State.Running}}' lightning-node\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"reload-the-daemon",children:"Reload the daemon"}),"\n",(0,r.jsx)(n.p,{children:"Reload the daemon by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl daemon-reload\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-the-systemd-service-unit-file",children:"Remove the Systemd Service Unit file"}),"\n",(0,r.jsx)(n.p,{children:"If you have followed the recommendations, you should find the Systemd Service Unit file at:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/etc/systemd/system/docker-lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"To remove the file, run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo rm -f /etc/systemd/system/docker-lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"delete-the-docker-image",children:"Delete the Docker image"}),"\n",(0,r.jsxs)(n.p,{children:["For our example, we'll assume that the Docker image for Fleek Network is the default ",(0,r.jsx)(n.code,{children:"lightning-node"}),". If you have created the image under a different name, change in accordance to your preference."]}),"\n",(0,r.jsx)(n.p,{children:"Delete the image by running the following command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo docker rmi $(docker images | grep 'lightning-node')\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To learn more about the docker image remove command, visit the official documentation ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/image_rm/",children:"here"})]}),"\n",(0,r.jsx)(n.h2,{id:"uninstall-docker",children:"Uninstall Docker"}),"\n",(0,r.jsx)(n.p,{children:"Uninstalling Docker should only be performed if you don't need in your system. If you already had Docker for some purpose, you should not have to uninstall it."}),"\n",(0,r.jsxs)(n.p,{children:["Visit the Docker official documentation site for uninstall instructions ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/desktop/uninstall/",children:"here"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"manage-keys",children:"Manage keys"}),"\n",(0,r.jsxs)(n.p,{children:["The configuration directory of Fleek Network is in the host machine file system. This is the directory where you can find the ",(0,r.jsx)(n.code,{children:"config.toml"}),", ",(0,r.jsx)(n.code,{children:"keystore"})," for the public keys, amongst others."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/home//.lightning\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For example, for the user ",(0,r.jsx)(n.code,{children:"lgtn"})," the location of these files is:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/home/lgtn/.lightning\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,r.jsx)(n.p,{children:"The directory can be deleted but have in mind that the keystore is located here. If you need to backup the keystore, be careful as this is not possible to recover by anyone. The keys are your responsibility."})}),"\n",(0,r.jsxs)(n.p,{children:["To learn more about the keystore read the guide ",(0,r.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you are happy to delete the directory, run the following command by replacing the ",(0,r.jsx)(n.code,{children:""})," by yours:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"rm -rf /home//.lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-the-logs",children:"Remove the logs"}),"\n",(0,r.jsx)(n.p,{children:"The Docker container generates output to stdout and stderr. All the content is stored in the location:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/var/log/lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"To completely remove the directory run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf /var/log/lightning\n"})}),"\n",(0,r.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var r=t(5893);const o=e=>{let{image:n,name:t,title:o,url:i,communityMember:s=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,r.jsx)("img",{src:n,alt:t})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,r.jsx)("span",{className:"title",children:o}),(0,r.jsxs)("span",{className:"discord",children:[s?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(7294);const o={},i=r.createContext(o);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[5767],{3183:(e,n,t)=>{t.d(n,{ZP:()=>s});var r=t(5893),o=t(1151);function i(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,r.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,r.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,r.jsxs)(n.li,{children:["Download the ",(0,r.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,r.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,r.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,r.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,r.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function s(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(i,{...e})}):i(e)}},1583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var r=t(5893),o=t(1151),i=t(3872);t(3183);const s={title:"Uninstall Docker Setup",slug:"uninstall-docker-setup",hide_title:!0,tags:["references","help","docker","image","container"]},c=void 0,l={id:"Docker/uninstall-docker-setup",title:"Uninstall Docker Setup",description:"Remove the source code locally",source:"@site/references/Docker/uninstall-docker-setup.md",sourceDirName:"Docker",slug:"/Docker/uninstall-docker-setup",permalink:"/references/Docker/uninstall-docker-setup",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/uninstall-docker-setup.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"docker",permalink:"/references/tags/docker"},{label:"image",permalink:"/references/tags/image"},{label:"container",permalink:"/references/tags/container"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Uninstall Docker Setup",slug:"uninstall-docker-setup",hide_title:!0,tags:["references","help","docker","image","container"]},sidebar:"defaultSidebar",previous:{title:"Frequently used commands for Docker setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup"},next:{title:"Error building on ARM64",permalink:"/references/Lightning CLI/error-building-on-arm64"}},a={},d=[{value:"Remove the source code locally",id:"remove-the-source-code-locally",level:2},{value:"Stop the Docker service",id:"stop-the-docker-service",level:2},{value:"Confirm the Docker service status",id:"confirm-the-docker-service-status",level:2},{value:"Reload the daemon",id:"reload-the-daemon",level:2},{value:"Remove the Systemd Service Unit file",id:"remove-the-systemd-service-unit-file",level:2},{value:"Delete the Docker image",id:"delete-the-docker-image",level:2},{value:"Uninstall Docker",id:"uninstall-docker",level:2},{value:"Manage keys",id:"manage-keys",level:2},{value:"Remove the logs",id:"remove-the-logs",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"remove-the-source-code-locally",children:"Remove the source code locally"}),"\n",(0,r.jsx)(n.p,{children:"For users who build the Docker image from source-code."}),"\n",(0,r.jsxs)(n.p,{children:["Assuming the default installation source-code path ",(0,r.jsx)(n.code,{children:"~/fleek-network/lightning"}),", run the command:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"rm -rf ~/fleek-network/lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"If you have a custom path, you need to change the pathname to the correct path you have selected during your custom install."}),"\n",(0,r.jsx)(n.h2,{id:"stop-the-docker-service",children:"Stop the Docker service"}),"\n",(0,r.jsx)(n.p,{children:"The Fleek Network recommends systemctl to manage the services, either natively or docker. It's an interface that is easily to translate across the setups, and to communicate to the users in a common manner."}),"\n",(0,r.jsx)(n.p,{children:"If you have followed the recommendations, you should have the Systemd Unit Service setup."}),"\n",(0,r.jsx)(n.p,{children:"To stop the service run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl stop docker-lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"confirm-the-docker-service-status",children:"Confirm the Docker service status"}),"\n",(0,r.jsx)(n.p,{children:"Check the status by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl status docker-lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"Disable the service by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl disable docker-lightning\n"})}),"\n",(0,r.jsxs)(n.admonition,{type:"tip",children:[(0,r.jsxs)(n.p,{children:["Once stop, you can run the following command to confirm it is not running. If you have used the recommended container name ",(0,r.jsx)(n.code,{children:"lightning-node"})," the command you'd have to execute is:"]}),(0,r.jsxs)(n.p,{children:["You can check the Docker container isn't running by running the following command. Notice that we are assuming that your docker container name is the default ",(0,r.jsx)(n.code,{children:"lightning-node"}),". If you have customized the name use the correct selected name:"]}),(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo docker container inspect -f '{{.State.Running}}' lightning-node\n"})})]}),"\n",(0,r.jsx)(n.h2,{id:"reload-the-daemon",children:"Reload the daemon"}),"\n",(0,r.jsx)(n.p,{children:"Reload the daemon by:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo systemctl daemon-reload\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-the-systemd-service-unit-file",children:"Remove the Systemd Service Unit file"}),"\n",(0,r.jsx)(n.p,{children:"If you have followed the recommendations, you should find the Systemd Service Unit file at:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/etc/systemd/system/docker-lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"To remove the file, run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"sudo rm -f /etc/systemd/system/docker-lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"delete-the-docker-image",children:"Delete the Docker image"}),"\n",(0,r.jsxs)(n.p,{children:["For our example, we'll assume that the Docker image for Fleek Network is the default ",(0,r.jsx)(n.code,{children:"lightning-node"}),". If you have created the image under a different name, change in accordance to your preference."]}),"\n",(0,r.jsx)(n.p,{children:"Delete the image by running the following command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo docker rmi $(docker images | grep 'lightning-node')\n"})}),"\n",(0,r.jsxs)(n.p,{children:["To learn more about the docker image remove command, visit the official documentation ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/engine/reference/commandline/image_rm/",children:"here"})]}),"\n",(0,r.jsx)(n.h2,{id:"uninstall-docker",children:"Uninstall Docker"}),"\n",(0,r.jsx)(n.p,{children:"Uninstalling Docker should only be performed if you don't need in your system. If you already had Docker for some purpose, you should not have to uninstall it."}),"\n",(0,r.jsxs)(n.p,{children:["Visit the Docker official documentation site for uninstall instructions ",(0,r.jsx)(n.a,{href:"https://docs.docker.com/desktop/uninstall/",children:"here"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"manage-keys",children:"Manage keys"}),"\n",(0,r.jsxs)(n.p,{children:["The configuration directory of Fleek Network is in the host machine file system. This is the directory where you can find the ",(0,r.jsx)(n.code,{children:"config.toml"}),", ",(0,r.jsx)(n.code,{children:"keystore"})," for the public keys, amongst others."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/home//.lightning\n"})}),"\n",(0,r.jsxs)(n.p,{children:["For example, for the user ",(0,r.jsx)(n.code,{children:"lgtn"})," the location of these files is:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/home/lgtn/.lightning\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"warning",type:"caution",children:(0,r.jsx)(n.p,{children:"The directory can be deleted but have in mind that the keystore is located here. If you need to backup the keystore, be careful as this is not possible to recover by anyone. The keys are your responsibility."})}),"\n",(0,r.jsxs)(n.p,{children:["To learn more about the keystore read the guide ",(0,r.jsx)(n.a,{href:"/guides/Node%20Operators/managing-the-keystore",children:"managing the keystore"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["If you are happy to delete the directory, run the following command by replacing the ",(0,r.jsx)(n.code,{children:""})," by yours:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"rm -rf /home//.lightning\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-the-logs",children:"Remove the logs"}),"\n",(0,r.jsx)(n.p,{children:"The Docker container generates output to stdout and stderr. All the content is stored in the location:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"/var/log/lightning\n"})}),"\n",(0,r.jsx)(n.p,{children:"To completely remove the directory run the command:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo rm -rf /var/log/lightning\n"})}),"\n",(0,r.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function m(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,t)=>{t.d(n,{Z:()=>o});t(7294);var r=t(5893);const o=e=>{let{image:n,name:t,title:o,url:i,communityMember:s=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,r.jsx)("img",{src:n,alt:t})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,r.jsx)("span",{className:"title",children:o}),(0,r.jsxs)("span",{className:"discord",children:[s?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(7294);const o={},i=r.createContext(o);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b2f554cd.61d2597d.js b/assets/js/b2f554cd.021cd732.js similarity index 99% rename from assets/js/b2f554cd.61d2597d.js rename to assets/js/b2f554cd.021cd732.js index 7110d4da7..1c842fde9 100644 --- a/assets/js/b2f554cd.61d2597d.js +++ b/assets/js/b2f554cd.021cd732.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1477],{10:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"bloom-and-cuckoo-filters-for-cache-summarization","metadata":{"permalink":"/blog/bloom-and-cuckoo-filters-for-cache-summarization","source":"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md","title":"Bloom Filters and Cuckoo Filters for Cache Summarization","description":"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.","date":"2023-11-03T16:36:44.000Z","formattedDate":"November 3, 2023","tags":[{"label":"fleek network","permalink":"/blog/tags/fleek-network"},{"label":"blog","permalink":"/blog/tags/blog"},{"label":"engineering","permalink":"/blog/tags/engineering"},{"label":"content routing","permalink":"/blog/tags/content-routing"}],"readingTime":10.37,"hasTruncateMarker":true,"authors":[{"name":"Matthias Wright","title":"Software Engineer","url":"https://github.com/matthias-wright","image_url":"https://github.com/matthias-wright.png","imageURL":"https://github.com/matthias-wright.png"}],"frontMatter":{"title":"Bloom Filters and Cuckoo Filters for Cache Summarization","description":"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.","slug":"bloom-and-cuckoo-filters-for-cache-summarization","image":"./assets/bloom-cuckoo/bloom.png?202301181528","authors":{"name":"Matthias Wright","title":"Software Engineer","url":"https://github.com/matthias-wright","image_url":"https://github.com/matthias-wright.png","imageURL":"https://github.com/matthias-wright.png"},"tags":["fleek network","blog","engineering","content routing"]},"unlisted":false},"content":"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.\\n\\n\x3c!--truncate--\x3e\\n\\n## Background\\n\\nNodes on Fleek Network currently use Counting Bloom filters to summarize their cached content. These cache summaries are exchanged with other nodes in order to facilitate content routing.\\n\\nIf a particular node does not store a requested piece of content, it can use the Bloom filters that it received from its peers to check if a peer stores the requested content.\\n\\nWe are using Counting Bloom filters rather than regular Bloom filters because we need to be able to remove elements from the filter to support cache eviction.\\n\\n## Bloom Filters\\n\\nA Bloom filter is a space-efficient probabilistic data structure that can be used to perform approximate set membership queries.\\nThe answer to an approximate set membership query is not `no` or `yes,` but rather `no` or `probably.` This `probably` is quantified with the false positive rate. \\n\\nOne of the convenient features of Bloom filters is that they can be configured to have a specific false positive rate.\\nOf course, there is a tradeoff here; the lower the false positive rate, the larger the memory footprint. Bloom filters support two operations: `insert` and `contains.` \\n\\nA Bloom filter is represented by an array of m bits together with k independent hash functions. To insert an element into the filter, it is hashed with each of the k hash functions.\\nThe resulting hashes are interpreted as integers (modulo m) to obtain k array positions. The bits at these positions are then set to 1 (if there aren\'t already 1). \\nTo check whether or not an element is contained in the filter, the element is hashed k times with the different hash functions.\\n\\nIf all bits at the resulting array positions are 1, the element is assumed to be present. If any of the k bits are zero, we can be certain that the queried element is not present in the set.\\n\\nHowever, even if all bits are 1, it might still be the case that the bits were set by a combination of other elements. This is where the aforementioned false positive rate comes into play. \\n\\nSince we also need a `remove` operation for our use case, we have been using Counting Bloom filters, a variant of Bloom filters.\\nCounting Bloom filters retain most of the properties that regular Bloom filters have. The `remove` operation comes at the cost of an increased memory footprint.\\n\\nEach position in the array is no longer a single bit but a group of bits representing a counter.\\nWhenever an element is inserted into the filter, the counters for all k positions are incremented by 1. To remove an element, we decrement the counters.\\n\\n## Cuckoo Filters\\n\\nBloom filters are the most known members of a class of data structures called Approximate Membership Query Filters (AMQ Filters).\\nA relatively recent addition to this class is the Cuckoo filter [1]. Cuckoo filters share many similarities with Bloom filters, especially Counting Bloom filters.\\n\\nThey are space-efficient and can be used for approximate set membership queries. Cuckoo filters also support the operations `insert,` `contains,` and `remove,` and have configurable false positive rates. \\n\\nCuckoo filters are based on Cuckoo hash tables [2] and leverage an optimization called partial-key cuckoo hashing. A basic Cuckoo hash table consists of an array of buckets.\\nWe determine two candidate buckets for each element using two different hash functions, h1 and h2. \\n\\nThe `contains` operation will check if either bucket contains the element.\\nFor insertion, if either bucket is empty, the element will be inserted into the empty bucket.\\n\\nIf neither bucket is empty, one of the buckets is selected, and the existing element is removed and inserted into its alternate location.\\nThis may trigger another relocation if the alternate location is not empty. \\n\\nAlthough the insertion operation may perform a sequence of relocations, the amortized runtime is O(1). \\n\\nMost implementations of Cuckoo hash tables and, consequently, Cuckoo filters will use buckets that can hold multiple elements, as proposed in [3].\\n\\nFor Cuckoo filters, the hash table size is reduced by only storing fingerprints - a bit string calculated from an element\'s hash - rather than key-value pairs.\\n\\nThe fingerprint size is derived from the desired false positive rate. \\nA problem that arises is that, to relocate existing fingerprints using the Cuckoo hashing approach described above, we need the original hash from which the fingerprint was derived.\\n\\nOf course, we could store this hash somewhere, but the whole point of using fingerprints is to reduce the memory footprint of the filter.\\n\\nThe solution to this predicament is the aforementioned partial-key cuckoo hashing, a technique for determining an element\'s alternate location using only its fingerprint. \\nFor a given element x, the two candidate buckets are computed as follows: \\n\\n\\n\x3c!-- \\nTODO: Install math forms renderer, till then use img\\n\\n$h_1(x) = \\\\text{hash}(x)$\\n\\n$h_2(x) = h_1(x) \\\\oplus \\\\text{hash}(\\\\text{fingerprint}(x))$\\n--\x3e\\n\\n![](./assets/bloom-cuckoo/math-formul.png?202301181528)\\n\\nAn important property of this technique is that h1(x) can also be computed from h2(x) and the fingerprint.\\n\\n## Benchmarking\\n\\nAs this post mentioned, we are not aiming for a general comparison of Counting Bloom and Cuckoo filters.\\n\\nInstead, we want to determine which filter suits our specific use case better. The two main properties we are looking for are space efficiency and lookup performance. \\n\\nSpace efficiency is important because nodes frequently update their cache and have to communicate these changes with their peers. These messages should take up as little bandwidth as possible.\\n\\nLookup speed is also important because Fleek Network aims to serve user requests as quickly as possible. Checking whether a peer has some content stored in their cache summary should not be a bottleneck. \\n\\n## Experimental Setup\\n\\nWe are using our own Counting Bloom filter [implementation](https://github.com/fleek-network/ursa/blob/483f4d56cbaa5e83182454d2c1db6f6af7c54912/crates/ursa-network/src/utils/bloom_filter.rs#L11) and [scalable cuckoo filter](https://github.com/sile/scalable_cuckoo_filter?gh) Cuckoo filter implementation in Rust, the [original cuckoofilter](https://github.com/efficient/cuckoofilter?gh) implementation is in C++. All experiments were performed on a Linux machine with 16 GB RAM and an Intel Core i7 (10th Gen). Whenever the experiment is probabilistic, we repeat the experiment 20 times and report the mean and standard deviation.\\n\\n## Memory Footprint\\n\\nFor both Counting Bloom filters and Cuckoo filters, the memory footprint is determined by two factors: the filter\'s capacity and the desired false positive rate. In the first experiment, we examine the impact that\\nthese factors have on the memory footprint. \\n\\nTo this end, we fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The result is shown in Fig. 1. \\nThe size of Bloom filters scales linearly with the capacity. Cuckoo filters are more space-efficient. This result is consistent with the experiments reported in [1].\\n\\n![](./assets/bloom-cuckoo/capacity-size.png?202301121718)\\n\\n> Figure 1: We fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The y-axis shows the size of the filters in Megabytes.\\n\\nNext, we fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. Fig. 2 shows that Cuckoo filters are more space-efficient.\\n\\nThe gap between Counting Bloom filters and Cuckoo filters grows as the false positive rate decreases. This is also consistent with experiments in [1].\\n\\n![](./assets/bloom-cuckoo/fp-rate-size.png?202301121718)\\n\\n> Figure 2: We fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. The y-axis shows the size of the filters in Megabytes.\\n\\n## Lookup Performance\\n\\nWe first add elements to both filters until the capacity is reached. We then measure the lookup performance for different ratios of positive and negative lookups.\\n\\nA positive lookup is for an existing element, and a negative lookup is for an element not contained in the filter. We perform 100K lookups for each ratio and report the average lookup duration and standard deviation. \\n\\nFig. 3 shows the results. Bloom filters perform slightly better on average than Cuckoo filters. This result is inconsistent with [1],\\nwhere Cuckoo filters were reported to have a better lookup performance than Bloom filters. It should be noted here that the authors in [1] use the original C++ Cuckoo filter implementation and their own unreleased Bloom filter implementation. In contrast, we use a Rust Cuckoo filter implementation and our Bloom filter implementation. We cannot easily determine the reason for this discrepancy.\\n\\nHowever, the performance difference is negligible.\\n\\n![](./assets/bloom-cuckoo/lookup.png?202301121718)\\n\\n> Figure 3: Lookup performance for different ratios of positive and negative lookups. For example, ratio 0.25 indicates that 25% of lookups are positive and 75% are negative.\\nThe shaded region indicates the standard deviation.\\n\\n## Insertion Performance\\n\\nLess critical than lookup performance but still important for our purposes is insertion performance. We measure how the insertion performance varies for different occupancy levels.\\nFig. 4 shows the results. The insertion performance is constant across all levels of occupancy for Bloom filters.\\n\\nFor Cuckoo filters, the performance decreases as the filter becomes fuller because more relocations are required. In Fig. 4, the performance for Bloom filters is not constant. It quickly increases and then remains constant. This can be explained by CPU caching. \\n\\n![](./assets/bloom-cuckoo/insert.png?202301121718)\\n\\n> Figure 4: Insertion performance for different occupancy levels. The shaded region indicates the standard deviation.\\n\\n## Capacity and Scaling\\n\\nWe have mentioned the capacity of a filter several times now. An interesting case is what happens when a filter\'s capacity is exceeded.\\nBloom filters and Cuckoo filters behave differently in this scenario.\\n\\nFor Bloom filters, the `insertion` operation always succeeds. However, the false positive rate will rapidly increase as we exceed the filter\'s capacity. While Bloom filters fail silently, Cuckoo filters are more explicit. Most implementations have a maximum number of\\nrelocations that will be performed for an insertion. The `insertion` operation will return an error if more relocations are required. \\n\\nFor both filters, we can avoid this problem by simply initializing the filter with a sufficiently large capacity. However, this will increase the memory footprint of the filter.\\n\\nFurthermore, it is difficult to predict how many elements a node on Fleek Network will cache. It is also likely that the number of cached elements will greatly vary for different nodes. \\n\\nFortunately, a variant of Bloom filters called Scalable Bloom Filters [4] can adapt dynamically to the number of elements stored while guaranteeing a maximum false positive rate.\\n\\nThe proposed technique is also applicable to Cuckoo filters.\\n\\n## Other Filters\\n\\nWhile we only looked at Bloom filters and Cuckoo filters, there are other AMQ filters that we want to mention here briefly:\\n\\n* Quotient filters [5, 6]: Compact hash tables that support insertion, lookup, and deletion. Less space-efficient than Bloom filters and Cuckoo filters. \\n\\n* XOR filters [7]: More space-efficient than Bloom filters and Cuckoo filters. However, they are static, meaning the filter has to be rebuilt if additional elements are added. \\n\\n## Conclusion\\n\\nWe examined whether Counting Bloom filters or Cuckoo filters are more suitable for summarizing caches on Fleek Network. Cuckoo filters are more space-efficient, especially for lower false positive rates. Bloom filters have a slightly better insertion and lookup performance for the implementations we tested.\\n\\nBoth filters can be adapted to grow and shrink in size dynamically. Since the difference in insertion and lookup performance is negligible while Cuckoo filters are significantly more space-efficient, we favor Cuckoo filters for our use case. \\n\\n### References\\n\\n[1] Bin Fan, Dave G. Andersen, Michael Kaminsky, and Michael D. Mitzenmacher. Cuckoo Filter: Practically Better Than Bloom.\\nIn Proceedings of the 10th ACM International Conference on emerging Networking Experiments and Technologies (CoNEXT 14). Association for Computing Machinery, New York, NY, USA, pp. 75-88, 2014. \\n\\n[2] Rasmus Pagha and Flemming Friche Rodler. Cuckoo hashing. Journal of Algorithms, 51(2), pp. 122-144, 2004. \\n\\n[3] Martin Dietzfelbinger and Christoph Weidling. Balanced Allocation and Dictionaries with Tightly Packed Constant Size Bins. Theoretical Computer Science, 380(1), pp. 47-68, 2007. \\n\\n[4] Paulo S. Almeida, Carlos Baquero, Nuno Pregui\xe7a, and David Hutchison. Scalable Bloom Filters. Information Processing Letters, 101(6), pp. 255-261, 2007. \\n\\n[5] John G. Cleary. Compact hash tables using bidirectional linear probing. IEEE Transactions on Computers. 33(9), pp. 828-834, 1984. \\n\\n[6] Anna Pagh, Rasmus Pagh, and S. Srinivasa Rao. An optimal Bloom filter replacement. Proceedings of the Sixteenth Annual ACM-SIAM Symposium on Discrete Algorithms, pp. 823-829, 2005. \\n \\n[7] Thomas Mueller Graf and Daniel Lemire. Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters. ACM Journal of Experimental Algorithmics. 25, pp. 1-16, 2020."}]}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1477],{10:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"bloom-and-cuckoo-filters-for-cache-summarization","metadata":{"permalink":"/blog/bloom-and-cuckoo-filters-for-cache-summarization","source":"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md","title":"Bloom Filters and Cuckoo Filters for Cache Summarization","description":"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.","date":"2023-11-03T16:48:06.000Z","formattedDate":"November 3, 2023","tags":[{"label":"fleek network","permalink":"/blog/tags/fleek-network"},{"label":"blog","permalink":"/blog/tags/blog"},{"label":"engineering","permalink":"/blog/tags/engineering"},{"label":"content routing","permalink":"/blog/tags/content-routing"}],"readingTime":10.37,"hasTruncateMarker":true,"authors":[{"name":"Matthias Wright","title":"Software Engineer","url":"https://github.com/matthias-wright","image_url":"https://github.com/matthias-wright.png","imageURL":"https://github.com/matthias-wright.png"}],"frontMatter":{"title":"Bloom Filters and Cuckoo Filters for Cache Summarization","description":"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.","slug":"bloom-and-cuckoo-filters-for-cache-summarization","image":"./assets/bloom-cuckoo/bloom.png?202301181528","authors":{"name":"Matthias Wright","title":"Software Engineer","url":"https://github.com/matthias-wright","image_url":"https://github.com/matthias-wright.png","imageURL":"https://github.com/matthias-wright.png"},"tags":["fleek network","blog","engineering","content routing"]},"unlisted":false},"content":"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.\\n\\n\x3c!--truncate--\x3e\\n\\n## Background\\n\\nNodes on Fleek Network currently use Counting Bloom filters to summarize their cached content. These cache summaries are exchanged with other nodes in order to facilitate content routing.\\n\\nIf a particular node does not store a requested piece of content, it can use the Bloom filters that it received from its peers to check if a peer stores the requested content.\\n\\nWe are using Counting Bloom filters rather than regular Bloom filters because we need to be able to remove elements from the filter to support cache eviction.\\n\\n## Bloom Filters\\n\\nA Bloom filter is a space-efficient probabilistic data structure that can be used to perform approximate set membership queries.\\nThe answer to an approximate set membership query is not `no` or `yes,` but rather `no` or `probably.` This `probably` is quantified with the false positive rate. \\n\\nOne of the convenient features of Bloom filters is that they can be configured to have a specific false positive rate.\\nOf course, there is a tradeoff here; the lower the false positive rate, the larger the memory footprint. Bloom filters support two operations: `insert` and `contains.` \\n\\nA Bloom filter is represented by an array of m bits together with k independent hash functions. To insert an element into the filter, it is hashed with each of the k hash functions.\\nThe resulting hashes are interpreted as integers (modulo m) to obtain k array positions. The bits at these positions are then set to 1 (if there aren\'t already 1). \\nTo check whether or not an element is contained in the filter, the element is hashed k times with the different hash functions.\\n\\nIf all bits at the resulting array positions are 1, the element is assumed to be present. If any of the k bits are zero, we can be certain that the queried element is not present in the set.\\n\\nHowever, even if all bits are 1, it might still be the case that the bits were set by a combination of other elements. This is where the aforementioned false positive rate comes into play. \\n\\nSince we also need a `remove` operation for our use case, we have been using Counting Bloom filters, a variant of Bloom filters.\\nCounting Bloom filters retain most of the properties that regular Bloom filters have. The `remove` operation comes at the cost of an increased memory footprint.\\n\\nEach position in the array is no longer a single bit but a group of bits representing a counter.\\nWhenever an element is inserted into the filter, the counters for all k positions are incremented by 1. To remove an element, we decrement the counters.\\n\\n## Cuckoo Filters\\n\\nBloom filters are the most known members of a class of data structures called Approximate Membership Query Filters (AMQ Filters).\\nA relatively recent addition to this class is the Cuckoo filter [1]. Cuckoo filters share many similarities with Bloom filters, especially Counting Bloom filters.\\n\\nThey are space-efficient and can be used for approximate set membership queries. Cuckoo filters also support the operations `insert,` `contains,` and `remove,` and have configurable false positive rates. \\n\\nCuckoo filters are based on Cuckoo hash tables [2] and leverage an optimization called partial-key cuckoo hashing. A basic Cuckoo hash table consists of an array of buckets.\\nWe determine two candidate buckets for each element using two different hash functions, h1 and h2. \\n\\nThe `contains` operation will check if either bucket contains the element.\\nFor insertion, if either bucket is empty, the element will be inserted into the empty bucket.\\n\\nIf neither bucket is empty, one of the buckets is selected, and the existing element is removed and inserted into its alternate location.\\nThis may trigger another relocation if the alternate location is not empty. \\n\\nAlthough the insertion operation may perform a sequence of relocations, the amortized runtime is O(1). \\n\\nMost implementations of Cuckoo hash tables and, consequently, Cuckoo filters will use buckets that can hold multiple elements, as proposed in [3].\\n\\nFor Cuckoo filters, the hash table size is reduced by only storing fingerprints - a bit string calculated from an element\'s hash - rather than key-value pairs.\\n\\nThe fingerprint size is derived from the desired false positive rate. \\nA problem that arises is that, to relocate existing fingerprints using the Cuckoo hashing approach described above, we need the original hash from which the fingerprint was derived.\\n\\nOf course, we could store this hash somewhere, but the whole point of using fingerprints is to reduce the memory footprint of the filter.\\n\\nThe solution to this predicament is the aforementioned partial-key cuckoo hashing, a technique for determining an element\'s alternate location using only its fingerprint. \\nFor a given element x, the two candidate buckets are computed as follows: \\n\\n\\n\x3c!-- \\nTODO: Install math forms renderer, till then use img\\n\\n$h_1(x) = \\\\text{hash}(x)$\\n\\n$h_2(x) = h_1(x) \\\\oplus \\\\text{hash}(\\\\text{fingerprint}(x))$\\n--\x3e\\n\\n![](./assets/bloom-cuckoo/math-formul.png?202301181528)\\n\\nAn important property of this technique is that h1(x) can also be computed from h2(x) and the fingerprint.\\n\\n## Benchmarking\\n\\nAs this post mentioned, we are not aiming for a general comparison of Counting Bloom and Cuckoo filters.\\n\\nInstead, we want to determine which filter suits our specific use case better. The two main properties we are looking for are space efficiency and lookup performance. \\n\\nSpace efficiency is important because nodes frequently update their cache and have to communicate these changes with their peers. These messages should take up as little bandwidth as possible.\\n\\nLookup speed is also important because Fleek Network aims to serve user requests as quickly as possible. Checking whether a peer has some content stored in their cache summary should not be a bottleneck. \\n\\n## Experimental Setup\\n\\nWe are using our own Counting Bloom filter [implementation](https://github.com/fleek-network/ursa/blob/483f4d56cbaa5e83182454d2c1db6f6af7c54912/crates/ursa-network/src/utils/bloom_filter.rs#L11) and [scalable cuckoo filter](https://github.com/sile/scalable_cuckoo_filter?gh) Cuckoo filter implementation in Rust, the [original cuckoofilter](https://github.com/efficient/cuckoofilter?gh) implementation is in C++. All experiments were performed on a Linux machine with 16 GB RAM and an Intel Core i7 (10th Gen). Whenever the experiment is probabilistic, we repeat the experiment 20 times and report the mean and standard deviation.\\n\\n## Memory Footprint\\n\\nFor both Counting Bloom filters and Cuckoo filters, the memory footprint is determined by two factors: the filter\'s capacity and the desired false positive rate. In the first experiment, we examine the impact that\\nthese factors have on the memory footprint. \\n\\nTo this end, we fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The result is shown in Fig. 1. \\nThe size of Bloom filters scales linearly with the capacity. Cuckoo filters are more space-efficient. This result is consistent with the experiments reported in [1].\\n\\n![](./assets/bloom-cuckoo/capacity-size.png?202301121718)\\n\\n> Figure 1: We fix the false positive rate and initialize the filters with capacities ranging from 100K to 1M. The y-axis shows the size of the filters in Megabytes.\\n\\nNext, we fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. Fig. 2 shows that Cuckoo filters are more space-efficient.\\n\\nThe gap between Counting Bloom filters and Cuckoo filters grows as the false positive rate decreases. This is also consistent with experiments in [1].\\n\\n![](./assets/bloom-cuckoo/fp-rate-size.png?202301121718)\\n\\n> Figure 2: We fix the capacity and initialize the filters with false positive rates ranging from 0.0001 to 0.5. The y-axis shows the size of the filters in Megabytes.\\n\\n## Lookup Performance\\n\\nWe first add elements to both filters until the capacity is reached. We then measure the lookup performance for different ratios of positive and negative lookups.\\n\\nA positive lookup is for an existing element, and a negative lookup is for an element not contained in the filter. We perform 100K lookups for each ratio and report the average lookup duration and standard deviation. \\n\\nFig. 3 shows the results. Bloom filters perform slightly better on average than Cuckoo filters. This result is inconsistent with [1],\\nwhere Cuckoo filters were reported to have a better lookup performance than Bloom filters. It should be noted here that the authors in [1] use the original C++ Cuckoo filter implementation and their own unreleased Bloom filter implementation. In contrast, we use a Rust Cuckoo filter implementation and our Bloom filter implementation. We cannot easily determine the reason for this discrepancy.\\n\\nHowever, the performance difference is negligible.\\n\\n![](./assets/bloom-cuckoo/lookup.png?202301121718)\\n\\n> Figure 3: Lookup performance for different ratios of positive and negative lookups. For example, ratio 0.25 indicates that 25% of lookups are positive and 75% are negative.\\nThe shaded region indicates the standard deviation.\\n\\n## Insertion Performance\\n\\nLess critical than lookup performance but still important for our purposes is insertion performance. We measure how the insertion performance varies for different occupancy levels.\\nFig. 4 shows the results. The insertion performance is constant across all levels of occupancy for Bloom filters.\\n\\nFor Cuckoo filters, the performance decreases as the filter becomes fuller because more relocations are required. In Fig. 4, the performance for Bloom filters is not constant. It quickly increases and then remains constant. This can be explained by CPU caching. \\n\\n![](./assets/bloom-cuckoo/insert.png?202301121718)\\n\\n> Figure 4: Insertion performance for different occupancy levels. The shaded region indicates the standard deviation.\\n\\n## Capacity and Scaling\\n\\nWe have mentioned the capacity of a filter several times now. An interesting case is what happens when a filter\'s capacity is exceeded.\\nBloom filters and Cuckoo filters behave differently in this scenario.\\n\\nFor Bloom filters, the `insertion` operation always succeeds. However, the false positive rate will rapidly increase as we exceed the filter\'s capacity. While Bloom filters fail silently, Cuckoo filters are more explicit. Most implementations have a maximum number of\\nrelocations that will be performed for an insertion. The `insertion` operation will return an error if more relocations are required. \\n\\nFor both filters, we can avoid this problem by simply initializing the filter with a sufficiently large capacity. However, this will increase the memory footprint of the filter.\\n\\nFurthermore, it is difficult to predict how many elements a node on Fleek Network will cache. It is also likely that the number of cached elements will greatly vary for different nodes. \\n\\nFortunately, a variant of Bloom filters called Scalable Bloom Filters [4] can adapt dynamically to the number of elements stored while guaranteeing a maximum false positive rate.\\n\\nThe proposed technique is also applicable to Cuckoo filters.\\n\\n## Other Filters\\n\\nWhile we only looked at Bloom filters and Cuckoo filters, there are other AMQ filters that we want to mention here briefly:\\n\\n* Quotient filters [5, 6]: Compact hash tables that support insertion, lookup, and deletion. Less space-efficient than Bloom filters and Cuckoo filters. \\n\\n* XOR filters [7]: More space-efficient than Bloom filters and Cuckoo filters. However, they are static, meaning the filter has to be rebuilt if additional elements are added. \\n\\n## Conclusion\\n\\nWe examined whether Counting Bloom filters or Cuckoo filters are more suitable for summarizing caches on Fleek Network. Cuckoo filters are more space-efficient, especially for lower false positive rates. Bloom filters have a slightly better insertion and lookup performance for the implementations we tested.\\n\\nBoth filters can be adapted to grow and shrink in size dynamically. Since the difference in insertion and lookup performance is negligible while Cuckoo filters are significantly more space-efficient, we favor Cuckoo filters for our use case. \\n\\n### References\\n\\n[1] Bin Fan, Dave G. Andersen, Michael Kaminsky, and Michael D. Mitzenmacher. Cuckoo Filter: Practically Better Than Bloom.\\nIn Proceedings of the 10th ACM International Conference on emerging Networking Experiments and Technologies (CoNEXT 14). Association for Computing Machinery, New York, NY, USA, pp. 75-88, 2014. \\n\\n[2] Rasmus Pagha and Flemming Friche Rodler. Cuckoo hashing. Journal of Algorithms, 51(2), pp. 122-144, 2004. \\n\\n[3] Martin Dietzfelbinger and Christoph Weidling. Balanced Allocation and Dictionaries with Tightly Packed Constant Size Bins. Theoretical Computer Science, 380(1), pp. 47-68, 2007. \\n\\n[4] Paulo S. Almeida, Carlos Baquero, Nuno Pregui\xe7a, and David Hutchison. Scalable Bloom Filters. Information Processing Letters, 101(6), pp. 255-261, 2007. \\n\\n[5] John G. Cleary. Compact hash tables using bidirectional linear probing. IEEE Transactions on Computers. 33(9), pp. 828-834, 1984. \\n\\n[6] Anna Pagh, Rasmus Pagh, and S. Srinivasa Rao. An optimal Bloom filter replacement. Proceedings of the Sixteenth Annual ACM-SIAM Symposium on Discrete Algorithms, pp. 823-829, 2005. \\n \\n[7] Thomas Mueller Graf and Daniel Lemire. Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters. ACM Journal of Experimental Algorithmics. 25, pp. 1-16, 2020."}]}')}}]); \ No newline at end of file diff --git a/assets/js/b35f1b7f.ffee93db.js b/assets/js/b35f1b7f.969eb0cf.js similarity index 99% rename from assets/js/b35f1b7f.ffee93db.js rename to assets/js/b35f1b7f.969eb0cf.js index 18358c81d..061d68d57 100644 --- a/assets/js/b35f1b7f.ffee93db.js +++ b/assets/js/b35f1b7f.969eb0cf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7706],{9747:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var n=t(5893),r=t(1151),i=t(3872);const c={title:"User service",slug:"user-service",hide_title:!0,tags:["references","help","user service","unit","systemctl","systemd"]},l=void 0,d={id:"Systemd/user-service",title:"User service",description:"A user should have the ability to run a Systemd user service unit without having to use sudo to control it.",source:"@site/references/Systemd/user-service.md",sourceDirName:"Systemd",slug:"/Systemd/user-service",permalink:"/references/Systemd/user-service",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/user-service.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"user service",permalink:"/references/tags/user-service"},{label:"unit",permalink:"/references/tags/unit"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"User service",slug:"user-service",hide_title:!0,tags:["references","help","user service","unit","systemctl","systemd"]},sidebar:"defaultSidebar",previous:{title:"Shutting down persistance",permalink:"/references/Systemd/shutting-down-persistance"}},o={},a=[{value:"Check --user support",id:"check---user-support",level:2},{value:"Put the service unit in the user service",id:"put-the-service-unit-in-the-user-service",level:2},{value:"Reload daemon",id:"reload-daemon",level:2},{value:"Systemd service control as --user",id:"systemd-service-control-as---user",level:2},{value:"Problem statement",id:"problem-statement",level:2}];function h(e){const s={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(s.p,{children:["A user should have the ability to run a Systemd user service unit without having to use ",(0,n.jsx)(s.code,{children:"sudo"})," to control it."]}),"\n",(0,n.jsxs)(s.h2,{id:"check---user-support",children:["Check ",(0,n.jsx)(s.code,{children:"--user"})," support"]}),"\n",(0,n.jsxs)(s.p,{children:["Use the ",(0,n.jsx)(s.code,{children:"--user"})," flag when getting the list of unit files."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user list-unit-files\n"})}),"\n",(0,n.jsx)(s.p,{children:"It should return a list of unit files."}),"\n",(0,n.jsx)(s.h2,{id:"put-the-service-unit-in-the-user-service",children:"Put the service unit in the user service"}),"\n",(0,n.jsx)(s.p,{children:"Create the Systemd user units directory:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo mkdir -p /etc/systemd/system/user\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Move the ",(0,n.jsx)(s.code,{children:"lightning.service"})," to the system user unit service directory:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"mv /etc/systemd/system/lightning.service /etc/systemd/system/user/lightning.service\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Check the ",(0,n.jsx)(s.strong,{children:"Load path when running in user mode (--user)"})," in ",(0,n.jsx)(s.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.unit.html",children:"Systemd unit"})," for other alternative user paths, or to understand how it works to customize your server accordingly."]}),"\n",(0,n.jsx)(s.h2,{id:"reload-daemon",children:"Reload daemon"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,n.jsxs)(s.h2,{id:"systemd-service-control-as---user",children:["Systemd service control as ",(0,n.jsx)(s.code,{children:"--user"})]}),"\n",(0,n.jsx)(s.p,{children:"Reload the Systemctl daemon by executing the command:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user daemon-reload\n"})}),"\n",(0,n.jsx)(s.p,{children:"Enable the service for starting up on system boot:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user enable lightning.service\n"})}),"\n",(0,n.jsx)(s.p,{children:"Start the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user start lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Stop the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user stop lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Restart the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user restart lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Check the service status by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user status lightning.service\n"})}),"\n",(0,n.jsx)(s.h2,{id:"problem-statement",children:"Problem statement"}),"\n",(0,n.jsxs)(s.p,{children:["On tests done in a DigitalOcean Ubuntu 22.x, we had set up user-level services which were operated with ",(0,n.jsx)(s.code,{children:"--user"}),". When the commands were executed as ",(0,n.jsx)(s.code,{children:"--user"})," it failed with:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"Failed to connect to bus: Operation not permitted (consider using --machine=@.host --user to connect to bus of other user)\n"})}),"\n",(0,n.jsx)(s.p,{children:"The user should be able to operate as user, it shouldn't be required to connect on behalf of other users. This means that even for a simple command, such as to retrieve the list of unit files:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user list-unit-files\n"})}),"\n",(0,n.jsx)(s.p,{children:"We'd get the error:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"Failed to connect to bus: Operation not permitted (consider using --machine=@.host --user to connect to bus of other user)\n"})}),"\n",(0,n.jsxs)(s.p,{children:["For any of the supported user unit locations e.g. $HOME/.config/systemd/user as documented in ",(0,n.jsx)(s.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.unit.html",children:"Systemd unit documentation"}),", the result is the error above."]}),"\n",(0,n.jsxs)(s.p,{children:["This is related to the load paths when running in user mode (--user), as described in the discussion ",(0,n.jsx)(s.a,{href:"https://unix.stackexchange.com/questions/224992/where-do-i-put-my-systemd-unit-file/367237#367237",children:"here"}),"."]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"User-dependent"})}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_CONFIG_HOME/systemd/user"})," User configuration (only used when $XDG_CONFIG_HOME is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$HOME/.config/systemd/user"})," User configuration (only used when $XDG_CONFIG_HOME is not set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_RUNTIME_DIR/systemd/user"})," Runtime units (only used when $XDG_RUNTIME_DIR is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_DATA_HOME/systemd/user"})," Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$HOME/.local/share/systemd/user"})," Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is not set)"]}),"\n",(0,n.jsxs)(s.p,{children:["For example, if we check the ",(0,n.jsx)(s.code,{children:"$XDG_RUNTIME_DIR"})," in a DigitalOcean box, we get the following output:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"/run/user/0\n"})}),"\n",(0,n.jsx)(s.p,{children:"For this reason and to provide support for a wider audience of users and systems, we've stuck to sudo to execute the service, but this should not be a requirement and is not recommended."}),"\n",(0,n.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,s,t)=>{t.d(s,{Z:()=>r});t(7294);var n=t(5893);const r=e=>{let{image:s,name:t,title:r,url:i,communityMember:c=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,n.jsx)("img",{src:s,alt:t})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,n.jsx)("span",{className:"title",children:r}),(0,n.jsxs)("span",{className:"discord",children:[c?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,t)=>{t.d(s,{Z:()=>l,a:()=>c});var n=t(7294);const r={},i=n.createContext(r);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[7706],{9747:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var n=t(5893),r=t(1151),i=t(3872);const c={title:"User service",slug:"user-service",hide_title:!0,tags:["references","help","user service","unit","systemctl","systemd"]},l=void 0,d={id:"Systemd/user-service",title:"User service",description:"A user should have the ability to run a Systemd user service unit without having to use sudo to control it.",source:"@site/references/Systemd/user-service.md",sourceDirName:"Systemd",slug:"/Systemd/user-service",permalink:"/references/Systemd/user-service",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Systemd/user-service.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"user service",permalink:"/references/tags/user-service"},{label:"unit",permalink:"/references/tags/unit"},{label:"systemctl",permalink:"/references/tags/systemctl"},{label:"systemd",permalink:"/references/tags/systemd"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"User service",slug:"user-service",hide_title:!0,tags:["references","help","user service","unit","systemctl","systemd"]},sidebar:"defaultSidebar",previous:{title:"Shutting down persistance",permalink:"/references/Systemd/shutting-down-persistance"}},o={},a=[{value:"Check --user support",id:"check---user-support",level:2},{value:"Put the service unit in the user service",id:"put-the-service-unit-in-the-user-service",level:2},{value:"Reload daemon",id:"reload-daemon",level:2},{value:"Systemd service control as --user",id:"systemd-service-control-as---user",level:2},{value:"Problem statement",id:"problem-statement",level:2}];function h(e){const s={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(s.p,{children:["A user should have the ability to run a Systemd user service unit without having to use ",(0,n.jsx)(s.code,{children:"sudo"})," to control it."]}),"\n",(0,n.jsxs)(s.h2,{id:"check---user-support",children:["Check ",(0,n.jsx)(s.code,{children:"--user"})," support"]}),"\n",(0,n.jsxs)(s.p,{children:["Use the ",(0,n.jsx)(s.code,{children:"--user"})," flag when getting the list of unit files."]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user list-unit-files\n"})}),"\n",(0,n.jsx)(s.p,{children:"It should return a list of unit files."}),"\n",(0,n.jsx)(s.h2,{id:"put-the-service-unit-in-the-user-service",children:"Put the service unit in the user service"}),"\n",(0,n.jsx)(s.p,{children:"Create the Systemd user units directory:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo mkdir -p /etc/systemd/system/user\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Move the ",(0,n.jsx)(s.code,{children:"lightning.service"})," to the system user unit service directory:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"mv /etc/systemd/system/lightning.service /etc/systemd/system/user/lightning.service\n"})}),"\n",(0,n.jsxs)(s.p,{children:["Check the ",(0,n.jsx)(s.strong,{children:"Load path when running in user mode (--user)"})," in ",(0,n.jsx)(s.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.unit.html",children:"Systemd unit"})," for other alternative user paths, or to understand how it works to customize your server accordingly."]}),"\n",(0,n.jsx)(s.h2,{id:"reload-daemon",children:"Reload daemon"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"sudo systemctl daemon-reload\n"})}),"\n",(0,n.jsxs)(s.h2,{id:"systemd-service-control-as---user",children:["Systemd service control as ",(0,n.jsx)(s.code,{children:"--user"})]}),"\n",(0,n.jsx)(s.p,{children:"Reload the Systemctl daemon by executing the command:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user daemon-reload\n"})}),"\n",(0,n.jsx)(s.p,{children:"Enable the service for starting up on system boot:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user enable lightning.service\n"})}),"\n",(0,n.jsx)(s.p,{children:"Start the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user start lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Stop the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user stop lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Restart the service by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user restart lightning\n"})}),"\n",(0,n.jsx)(s.p,{children:"Check the service status by:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user status lightning.service\n"})}),"\n",(0,n.jsx)(s.h2,{id:"problem-statement",children:"Problem statement"}),"\n",(0,n.jsxs)(s.p,{children:["On tests done in a DigitalOcean Ubuntu 22.x, we had set up user-level services which were operated with ",(0,n.jsx)(s.code,{children:"--user"}),". When the commands were executed as ",(0,n.jsx)(s.code,{children:"--user"})," it failed with:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"Failed to connect to bus: Operation not permitted (consider using --machine=@.host --user to connect to bus of other user)\n"})}),"\n",(0,n.jsx)(s.p,{children:"The user should be able to operate as user, it shouldn't be required to connect on behalf of other users. This means that even for a simple command, such as to retrieve the list of unit files:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"systemctl --user list-unit-files\n"})}),"\n",(0,n.jsx)(s.p,{children:"We'd get the error:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"Failed to connect to bus: Operation not permitted (consider using --machine=@.host --user to connect to bus of other user)\n"})}),"\n",(0,n.jsxs)(s.p,{children:["For any of the supported user unit locations e.g. $HOME/.config/systemd/user as documented in ",(0,n.jsx)(s.a,{href:"https://www.freedesktop.org/software/systemd/man/systemd.unit.html",children:"Systemd unit documentation"}),", the result is the error above."]}),"\n",(0,n.jsxs)(s.p,{children:["This is related to the load paths when running in user mode (--user), as described in the discussion ",(0,n.jsx)(s.a,{href:"https://unix.stackexchange.com/questions/224992/where-do-i-put-my-systemd-unit-file/367237#367237",children:"here"}),"."]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"User-dependent"})}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_CONFIG_HOME/systemd/user"})," User configuration (only used when $XDG_CONFIG_HOME is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$HOME/.config/systemd/user"})," User configuration (only used when $XDG_CONFIG_HOME is not set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_RUNTIME_DIR/systemd/user"})," Runtime units (only used when $XDG_RUNTIME_DIR is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$XDG_DATA_HOME/systemd/user"})," Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is set)"]}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"$HOME/.local/share/systemd/user"})," Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is not set)"]}),"\n",(0,n.jsxs)(s.p,{children:["For example, if we check the ",(0,n.jsx)(s.code,{children:"$XDG_RUNTIME_DIR"})," in a DigitalOcean box, we get the following output:"]}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-sh",children:"/run/user/0\n"})}),"\n",(0,n.jsx)(s.p,{children:"For this reason and to provide support for a wider audience of users and systems, we've stuck to sudo to execute the service, but this should not be a requirement and is not recommended."}),"\n",(0,n.jsx)(i.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},3872:(e,s,t)=>{t.d(s,{Z:()=>r});t(7294);var n=t(5893);const r=e=>{let{image:s,name:t,title:r,url:i,communityMember:c=!1}=e;return(0,n.jsx)("section",{className:"author_card",children:(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"avatar",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:(0,n.jsx)("img",{src:s,alt:t})})}),(0,n.jsxs)("div",{children:[(0,n.jsx)("span",{className:"name",children:(0,n.jsx)("a",{href:i,target:"_blank",alt:t,children:t})}),(0,n.jsx)("span",{className:"title",children:r}),(0,n.jsxs)("span",{className:"discord",children:[c?"Join our community on":"Got questions? Find us on"," ",(0,n.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,s,t)=>{t.d(s,{Z:()=>l,a:()=>c});var n=t(7294);const r={},i=n.createContext(r);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1b78a4d.51b5e6ba.js b/assets/js/d1b78a4d.a6a62d4b.js similarity index 98% rename from assets/js/d1b78a4d.51b5e6ba.js rename to assets/js/d1b78a4d.a6a62d4b.js index c35f94290..e3d9f2f53 100644 --- a/assets/js/d1b78a4d.51b5e6ba.js +++ b/assets/js/d1b78a4d.a6a62d4b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[3023],{756:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var i=o(5893),n=o(1151);const r={title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},a=void 0,s={permalink:"/blog/bloom-and-cuckoo-filters-for-cache-summarization",source:"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md",title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",date:"2023-11-03T16:36:44.000Z",formattedDate:"November 3, 2023",tags:[{label:"fleek network",permalink:"/blog/tags/fleek-network"},{label:"blog",permalink:"/blog/tags/blog"},{label:"engineering",permalink:"/blog/tags/engineering"},{label:"content routing",permalink:"/blog/tags/content-routing"}],readingTime:10.37,hasTruncateMarker:!0,authors:[{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"}],frontMatter:{title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},unlisted:!1},l={image:o(9969).Z,authorsImageUrls:[void 0]},m=[];function c(t){const e={p:"p",...(0,n.a)(),...t.components};return(0,i.jsx)(e.p,{children:"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case."})}function u(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(c,{...t})}):c(t)}},9969:(t,e,o)=>{o.d(e,{Z:()=>i});const i=o.p+"assets/images/bloom-79da0db687b4fb2060758838b9c44513.png"},1151:(t,e,o)=>{o.d(e,{Z:()=>s,a:()=>a});var i=o(7294);const n={},r=i.createContext(n);function a(t){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function s(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:a(t.components),i.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[3023],{756:(t,e,o)=>{o.r(e),o.d(e,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var i=o(5893),n=o(1151);const r={title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},a=void 0,s={permalink:"/blog/bloom-and-cuckoo-filters-for-cache-summarization",source:"@site/blog/bloom-and-cuckoo-filters-for-cache-summarization.md",title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",date:"2023-11-03T16:48:06.000Z",formattedDate:"November 3, 2023",tags:[{label:"fleek network",permalink:"/blog/tags/fleek-network"},{label:"blog",permalink:"/blog/tags/blog"},{label:"engineering",permalink:"/blog/tags/engineering"},{label:"content routing",permalink:"/blog/tags/content-routing"}],readingTime:10.37,hasTruncateMarker:!0,authors:[{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"}],frontMatter:{title:"Bloom Filters and Cuckoo Filters for Cache Summarization",description:"Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.",slug:"bloom-and-cuckoo-filters-for-cache-summarization",image:"./assets/bloom-cuckoo/bloom.png?202301181528",authors:{name:"Matthias Wright",title:"Software Engineer",url:"https://github.com/matthias-wright",image_url:"https://github.com/matthias-wright.png",imageURL:"https://github.com/matthias-wright.png"},tags:["fleek network","blog","engineering","content routing"]},unlisted:!1},l={image:o(9969).Z,authorsImageUrls:[void 0]},m=[];function c(t){const e={p:"p",...(0,n.a)(),...t.components};return(0,i.jsx)(e.p,{children:"Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case."})}function u(t={}){const{wrapper:e}={...(0,n.a)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(c,{...t})}):c(t)}},9969:(t,e,o)=>{o.d(e,{Z:()=>i});const i=o.p+"assets/images/bloom-79da0db687b4fb2060758838b9c44513.png"},1151:(t,e,o)=>{o.d(e,{Z:()=>s,a:()=>a});var i=o(7294);const n={},r=i.createContext(n);function a(t){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function s(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:a(t.components),i.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/d23df0ea.c3394e4f.js b/assets/js/d23df0ea.9d31279d.js similarity index 99% rename from assets/js/d23df0ea.c3394e4f.js rename to assets/js/d23df0ea.9d31279d.js index bd874f8a6..9a9459039 100644 --- a/assets/js/d23df0ea.c3394e4f.js +++ b/assets/js/d23df0ea.9d31279d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[5548],{3183:(e,n,r)=>{r.d(n,{ZP:()=>l});var t=r(5893),i=r(1151);function o(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(n.admonition,{type:"tip",children:[(0,t.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,t.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,t.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,t.jsxs)(n.li,{children:["Download the ",(0,t.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,t.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,t.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,t.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},5081:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>g,frontMatter:()=>s,metadata:()=>a,toc:()=>h});var t=r(5893),i=r(1151),o=r(3872),l=r(3183);const s={title:"Build and run in Docker",slug:"build-and-run-in-docker",hide_title:!0,tags:["references","help","docker","build","image","container"]},c=void 0,a={id:"Docker/build-and-run-in-docker",title:"Build and run in Docker",description:"Clone the source code locally",source:"@site/references/Docker/build-and-run-in-docker.md",sourceDirName:"Docker",slug:"/Docker/build-and-run-in-docker",permalink:"/references/Docker/build-and-run-in-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/build-and-run-in-docker.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"docker",permalink:"/references/tags/docker"},{label:"build",permalink:"/references/tags/build"},{label:"image",permalink:"/references/tags/image"},{label:"container",permalink:"/references/tags/container"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Build and run in Docker",slug:"build-and-run-in-docker",hide_title:!0,tags:["references","help","docker","build","image","container"]},sidebar:"defaultSidebar",previous:{title:"About references",permalink:"/references/"},next:{title:"Frequently used commands for Docker setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup"}},d={},h=[{value:"Clone the source code locally",id:"clone-the-source-code-locally",level:2},{value:"Change directory to Lightning source code",id:"change-directory-to-lightning-source-code",level:2},{value:"Install Docker",id:"install-docker",level:2},{value:"Docker setup verification",id:"docker-setup-verification",level:2},{value:"Check the Dockerfile",id:"check-the-dockerfile",level:2},{value:"Build the Docker image",id:"build-the-docker-image",level:2},{value:"Generate keys",id:"generate-keys",level:2},{value:"Docker Container",id:"docker-container",level:2},{value:"View logs",id:"view-logs",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"clone-the-source-code-locally",children:"Clone the source code locally"}),"\n",(0,t.jsx)(l.ZP,{}),"\n",(0,t.jsx)(n.h2,{id:"change-directory-to-lightning-source-code",children:"Change directory to Lightning source code"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"install-docker",children:"Install Docker"}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["We're using Ubuntu Linux. You'll have to make the required tweaks for your preferred Linux Distro. Find the list of support operating systems ",(0,t.jsx)(n.a,{href:"/docs/node/requirements#server",children:"here"}),"."]})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt update\n"})}),"\n",(0,t.jsx)(n.p,{children:"Next, install the required packages to let apt use packages over HTTPS:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt install \\\n apt-transport-https \\\n ca-certificates \\\n software-properties-common\n"})}),"\n",(0,t.jsx)(n.p,{children:"Add the GPG key for the official Docker repository to your system:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -\n"})}),"\n",(0,t.jsx)(n.p,{children:"Add the Docker repository to apt sources and update the package database with the Docker packages from the new added repository:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu jammy stable"\n'})}),"\n",(0,t.jsx)(n.p,{children:"Set to install from the Docker repo instead of the default Ubuntu repo:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"apt-cache policy docker-ce\n"})}),"\n",(0,t.jsx)(n.p,{children:"Finally, install Docker:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt install docker-ce\n"})}),"\n",(0,t.jsx)(n.p,{children:"Once complete you should be able to run it via the CLI, as such:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"docker -v\n"})}),"\n",(0,t.jsx)(n.p,{children:"Here's the output (versions might differ a bit from the time of writing):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"Docker version 24.0.6, build ed223bc\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker-setup-verification",children:"Docker setup verification"}),"\n",(0,t.jsx)(n.p,{children:"The following command's output will indicate if Docker's working correctly:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker run hello-world\n"})}),"\n",(0,t.jsx)(n.p,{children:'You should get a "Hello from Docker!".'}),"\n",(0,t.jsx)(n.h2,{id:"check-the-dockerfile",children:"Check the Dockerfile"}),"\n",(0,t.jsxs)(n.p,{children:["You should have ",(0,t.jsx)(n.a,{href:"#change-directory-to-lightning-source-code",children:"changed directory"})," to the projecto directory."]}),"\n",(0,t.jsxs)(n.p,{children:["If you run a ",(0,t.jsx)(n.code,{children:"cat Dockerfile"}),", you should have content similar to:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"FROM rust:latest as builder\nARG PROFILE=release\nWORKDIR /lightning\n\nRUN apt-get update\nRUN apt-get install -y \\\n build-essential \\\n cmake \\\n clang \\\n pkg-config \\\n libssl-dev \\\n gcc \\\n protobuf-compiler\n\n...\n"})}),"\n",(0,t.jsx)(n.h2,{id:"build-the-docker-image",children:"Build the Docker image"}),"\n",(0,t.jsxs)(n.p,{children:["Build the image named as ",(0,t.jsx)(n.code,{children:"lightning"})," from our Dockerfile:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker build -t lightning -f ./Dockerfile .\n"})}),"\n",(0,t.jsx)(n.h2,{id:"generate-keys",children:"Generate keys"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn keys generate\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker-container",children:"Docker Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"view-logs",children:"View logs"}),"\n",(0,t.jsx)(n.p,{children:"To view the logs of a Docker container in real time, use the following command:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,t.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},3872:(e,n,r)=>{r.d(n,{Z:()=>i});r(7294);var t=r(5893);const i=e=>{let{image:n,name:r,title:i,url:o,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:r,children:(0,t.jsx)("img",{src:n,alt:r})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:r,children:r})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>l});var t=r(7294);const i={},o=t.createContext(i);function l(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[5548],{3183:(e,n,r)=>{r.d(n,{ZP:()=>l});var t=r(5893),i=r(1151);function o(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(n.admonition,{type:"tip",children:[(0,t.jsx)(n.p,{children:"You have several ways of doing this:"}),(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Clone via HTTPS"}),"\n",(0,t.jsx)(n.li,{children:"Clone via SSH"}),"\n",(0,t.jsx)(n.li,{children:"Download via Github CLI"}),"\n",(0,t.jsxs)(n.li,{children:["Download the ",(0,t.jsx)(n.a,{href:"https://github.com/fleek-network/lightning/archive/refs/heads/main.zip",children:"zip package"})," from the repository"]}),"\n"]}),(0,t.jsxs)(n.p,{children:["We recommend HTTPS because it is the easiest to set up in the wild, and by users who are new to all this.\nAlthough, we strongly recommend using an SSH connection when interacting with GitHub. If you are to this and are interested read more about it ",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/authentication/connecting-to-github-with-ssh",children:"here"}),"."]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git \n"})}),(0,t.jsxs)(n.p,{children:["At time of writing, we are checking the branch name ",(0,t.jsx)(n.code,{children:"testnet-alpha-1"})," that corresponds to the testnet phase.\nHere's an example of what it'd look like when sticking to the recommended path location:"]}),(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"git clone -b testnet-alpha-1 https://github.com/fleek-network/lightning.git ~/fleek-network/lightning\n"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},5081:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>g,frontMatter:()=>s,metadata:()=>a,toc:()=>h});var t=r(5893),i=r(1151),o=r(3872),l=r(3183);const s={title:"Build and run in Docker",slug:"build-and-run-in-docker",hide_title:!0,tags:["references","help","docker","build","image","container"]},c=void 0,a={id:"Docker/build-and-run-in-docker",title:"Build and run in Docker",description:"Clone the source code locally",source:"@site/references/Docker/build-and-run-in-docker.md",sourceDirName:"Docker",slug:"/Docker/build-and-run-in-docker",permalink:"/references/Docker/build-and-run-in-docker",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Docker/build-and-run-in-docker.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"docker",permalink:"/references/tags/docker"},{label:"build",permalink:"/references/tags/build"},{label:"image",permalink:"/references/tags/image"},{label:"container",permalink:"/references/tags/container"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Build and run in Docker",slug:"build-and-run-in-docker",hide_title:!0,tags:["references","help","docker","build","image","container"]},sidebar:"defaultSidebar",previous:{title:"About references",permalink:"/references/"},next:{title:"Frequently used commands for Docker setup",permalink:"/references/Docker/frequently-used-commands-for-docker-setup"}},d={},h=[{value:"Clone the source code locally",id:"clone-the-source-code-locally",level:2},{value:"Change directory to Lightning source code",id:"change-directory-to-lightning-source-code",level:2},{value:"Install Docker",id:"install-docker",level:2},{value:"Docker setup verification",id:"docker-setup-verification",level:2},{value:"Check the Dockerfile",id:"check-the-dockerfile",level:2},{value:"Build the Docker image",id:"build-the-docker-image",level:2},{value:"Generate keys",id:"generate-keys",level:2},{value:"Docker Container",id:"docker-container",level:2},{value:"View logs",id:"view-logs",level:2}];function u(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"clone-the-source-code-locally",children:"Clone the source code locally"}),"\n",(0,t.jsx)(l.ZP,{}),"\n",(0,t.jsx)(n.h2,{id:"change-directory-to-lightning-source-code",children:"Change directory to Lightning source code"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"cd ~/fleek-network/lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"install-docker",children:"Install Docker"}),"\n",(0,t.jsx)(n.admonition,{type:"tip",children:(0,t.jsxs)(n.p,{children:["We're using Ubuntu Linux. You'll have to make the required tweaks for your preferred Linux Distro. Find the list of support operating systems ",(0,t.jsx)(n.a,{href:"/docs/node/requirements#server",children:"here"}),"."]})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt update\n"})}),"\n",(0,t.jsx)(n.p,{children:"Next, install the required packages to let apt use packages over HTTPS:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt install \\\n apt-transport-https \\\n ca-certificates \\\n software-properties-common\n"})}),"\n",(0,t.jsx)(n.p,{children:"Add the GPG key for the official Docker repository to your system:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -\n"})}),"\n",(0,t.jsx)(n.p,{children:"Add the Docker repository to apt sources and update the package database with the Docker packages from the new added repository:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu jammy stable"\n'})}),"\n",(0,t.jsx)(n.p,{children:"Set to install from the Docker repo instead of the default Ubuntu repo:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"apt-cache policy docker-ce\n"})}),"\n",(0,t.jsx)(n.p,{children:"Finally, install Docker:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo apt install docker-ce\n"})}),"\n",(0,t.jsx)(n.p,{children:"Once complete you should be able to run it via the CLI, as such:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"docker -v\n"})}),"\n",(0,t.jsx)(n.p,{children:"Here's the output (versions might differ a bit from the time of writing):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"Docker version 24.0.6, build ed223bc\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker-setup-verification",children:"Docker setup verification"}),"\n",(0,t.jsx)(n.p,{children:"The following command's output will indicate if Docker's working correctly:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker run hello-world\n"})}),"\n",(0,t.jsx)(n.p,{children:'You should get a "Hello from Docker!".'}),"\n",(0,t.jsx)(n.h2,{id:"check-the-dockerfile",children:"Check the Dockerfile"}),"\n",(0,t.jsxs)(n.p,{children:["You should have ",(0,t.jsx)(n.a,{href:"#change-directory-to-lightning-source-code",children:"changed directory"})," to the projecto directory."]}),"\n",(0,t.jsxs)(n.p,{children:["If you run a ",(0,t.jsx)(n.code,{children:"cat Dockerfile"}),", you should have content similar to:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"FROM rust:latest as builder\nARG PROFILE=release\nWORKDIR /lightning\n\nRUN apt-get update\nRUN apt-get install -y \\\n build-essential \\\n cmake \\\n clang \\\n pkg-config \\\n libssl-dev \\\n gcc \\\n protobuf-compiler\n\n...\n"})}),"\n",(0,t.jsx)(n.h2,{id:"build-the-docker-image",children:"Build the Docker image"}),"\n",(0,t.jsxs)(n.p,{children:["Build the image named as ",(0,t.jsx)(n.code,{children:"lightning"})," from our Dockerfile:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker build -t lightning -f ./Dockerfile .\n"})}),"\n",(0,t.jsx)(n.h2,{id:"generate-keys",children:"Generate keys"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker exec -it lightning-node lgtn keys generate\n"})}),"\n",(0,t.jsx)(n.h2,{id:"docker-container",children:"Docker Container"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker run \\\n -p 4200-4299:4200-4299 \\\n -p 4300-4399:4300-4399 \\\n --mount type=bind,source=$HOME/.lightning,target=/home/lgtn/.lightning \\\n --mount type=bind,source=/var/tmp,target=/var/tmp \\\n --name lightning-node \\\n -it lightning\n"})}),"\n",(0,t.jsx)(n.h2,{id:"view-logs",children:"View logs"}),"\n",(0,t.jsx)(n.p,{children:"To view the logs of a Docker container in real time, use the following command:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"sudo docker logs -f lightning-node\n"})}),"\n",(0,t.jsx)(o.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},3872:(e,n,r)=>{r.d(n,{Z:()=>i});r(7294);var t=r(5893);const i=e=>{let{image:n,name:r,title:i,url:o,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:r,children:(0,t.jsx)("img",{src:n,alt:r})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:o,target:"_blank",alt:r,children:r})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>l});var t=r(7294);const i={},o=t.createContext(i);function l(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d7d81bf6.6664e938.js b/assets/js/d7d81bf6.63c91c8c.js similarity index 99% rename from assets/js/d7d81bf6.6664e938.js rename to assets/js/d7d81bf6.63c91c8c.js index 70c04de2d..5cc6d4304 100644 --- a/assets/js/d7d81bf6.6664e938.js +++ b/assets/js/d7d81bf6.63c91c8c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2918],{6710:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var t=r(5893),i=r(1151),s=r(3872);const l={title:"Error building on ARM64",slug:"error-building-on-arm64",hide_title:!0,tags:["references","help","fix"]},a=void 0,o={id:"Lightning CLI/error-building-on-arm64",title:"Error building on ARM64",description:"Building on the ARM64 (aarch64)",source:"@site/references/Lightning CLI/error-building-on-arm64.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/error-building-on-arm64",permalink:"/references/Lightning CLI/error-building-on-arm64",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/error-building-on-arm64.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Error building on ARM64",slug:"error-building-on-arm64",hide_title:!0,tags:["references","help","fix"]},sidebar:"defaultSidebar",previous:{title:"Uninstall Docker Setup",permalink:"/references/Docker/uninstall-docker-setup"},next:{title:"Error linking with cc",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1"}},c={},d=[{value:"Building on the ARM64 (aarch64)",id:"building-on-the-arm64-aarch64",level:2}];function h(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"building-on-the-arm64-aarch64",children:"Building on the ARM64 (aarch64)"}),"\n",(0,t.jsxs)(n.p,{children:["ARM64 platform has its own specifics, and currently consists of requiring ",(0,t.jsx)(n.code,{children:"gcc"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"sudo apt install gcc\n"})}),"\n",(0,t.jsxs)(n.p,{children:["On cargo build, the error ",(0,t.jsx)(n.code,{children:"error: linking with "}),"cc",(0,t.jsx)(n.code,{children:" failed: exit status: 1"})," occurs, as demonstrated in the output below:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"error: linking with `cc` failed: exit status: 1\n# ... wall of text\n# ... the key error is \u21b4\n= note: /usr/bin/ld: /home/ubuntu/fleek-network/lightning/target/release/deps/libblake3-a927e9b36d695ff0.rlib(blake3-a927e9b36d695ff0.blake3.91a53ea05847a7a5-cgu.0.rcgu.o): in function `blake3_compress_in_place_portable':\n /home/ubuntu/.cargo/registry/src/index.crates.io-6f17d22bba15001f/blake3-1.4.1/src/ffi_neon.rs:45: multiple definition of `blake3_compress_in_place_portable'; /home/ubuntu/fleek-network/lightning/target/release/deps/libfleek_blake3-990c4c0cfb4eaa87.rlib(fleek_blake3-990c4c0cfb4eaa87.fleek_blake3.4f11e9370af31773-cgu.0.rcgu.o):/home/ubuntu/.cargo/registry/src/index.crates.io-6f17d22bba15001f/fleek-blake3-1.4.1/src/ffi_neon.rs:45: first defined here\n"})}),"\n",(0,t.jsxs)(n.p,{children:["As a result of the ",(0,t.jsx)(n.a,{href:"https://github.com/ryssroad/fleek-aarch64-build",children:"research"})," by the community member ",(0,t.jsx)(n.a,{href:"https://github.com/ryssroad",children:"ryssroad"}),", the following solution was shared."]}),"\n",(0,t.jsxs)(n.p,{children:["Open the ",(0,t.jsx)(n.code,{children:"cargo.toml"})," file in ",(0,t.jsx)(n.code,{children:"~/fleek-network/lightning/Cargo.toml"})," and find the ",(0,t.jsx)(n.code,{children:"lto"})," key."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lto = true\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Change the ",(0,t.jsx)(n.code,{children:"lto"})," key value from ",(0,t.jsx)(n.code,{children:"true"})," to ",(0,t.jsx)(n.code,{children:"thin"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'...\n[profile.release]\n# currently enabled, may increase build time, but runtime faster, can set to `"thin"`.\nlto = "thin"\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Set ",(0,t.jsx)(n.code,{children:"RUSTFLAGS"})," on build, as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:'RUSTFLAGS="-Clink-arg=-Wl,--allow-multiple-definition" cargo +stable build --release \n'})}),"\n",(0,t.jsxs)(n.p,{children:["Once the build completes, you should find the generated binary ",(0,t.jsx)(n.code,{children:"lightning-node"})," under the directory ",(0,t.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"As an example, execute:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"~/fleek-network/lightning/target/release/lightning-node help\n"})}),"\n",(0,t.jsx)(n.p,{children:"To find the help output:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"Usage: lightning-node [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,t.jsx)(s.Z,{name:"Road aka @road",image:"https://github.com/ryssroad.png",title:"Community member",url:"https://github.com/ryssroad",communityMember:"true"})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,r)=>{r.d(n,{Z:()=>i});r(7294);var t=r(5893);const i=e=>{let{image:n,name:r,title:i,url:s,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:s,target:"_blank",alt:r,children:(0,t.jsx)("img",{src:n,alt:r})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:s,target:"_blank",alt:r,children:r})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>l});var t=r(7294);const i={},s=t.createContext(i);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[2918],{6710:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var t=r(5893),i=r(1151),s=r(3872);const l={title:"Error building on ARM64",slug:"error-building-on-arm64",hide_title:!0,tags:["references","help","fix"]},a=void 0,o={id:"Lightning CLI/error-building-on-arm64",title:"Error building on ARM64",description:"Building on the ARM64 (aarch64)",source:"@site/references/Lightning CLI/error-building-on-arm64.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/error-building-on-arm64",permalink:"/references/Lightning CLI/error-building-on-arm64",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/error-building-on-arm64.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Error building on ARM64",slug:"error-building-on-arm64",hide_title:!0,tags:["references","help","fix"]},sidebar:"defaultSidebar",previous:{title:"Uninstall Docker Setup",permalink:"/references/Docker/uninstall-docker-setup"},next:{title:"Error linking with cc",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1"}},c={},d=[{value:"Building on the ARM64 (aarch64)",id:"building-on-the-arm64-aarch64",level:2}];function h(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"building-on-the-arm64-aarch64",children:"Building on the ARM64 (aarch64)"}),"\n",(0,t.jsxs)(n.p,{children:["ARM64 platform has its own specifics, and currently consists of requiring ",(0,t.jsx)(n.code,{children:"gcc"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"sudo apt install gcc\n"})}),"\n",(0,t.jsxs)(n.p,{children:["On cargo build, the error ",(0,t.jsx)(n.code,{children:"error: linking with "}),"cc",(0,t.jsx)(n.code,{children:" failed: exit status: 1"})," occurs, as demonstrated in the output below:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"error: linking with `cc` failed: exit status: 1\n# ... wall of text\n# ... the key error is \u21b4\n= note: /usr/bin/ld: /home/ubuntu/fleek-network/lightning/target/release/deps/libblake3-a927e9b36d695ff0.rlib(blake3-a927e9b36d695ff0.blake3.91a53ea05847a7a5-cgu.0.rcgu.o): in function `blake3_compress_in_place_portable':\n /home/ubuntu/.cargo/registry/src/index.crates.io-6f17d22bba15001f/blake3-1.4.1/src/ffi_neon.rs:45: multiple definition of `blake3_compress_in_place_portable'; /home/ubuntu/fleek-network/lightning/target/release/deps/libfleek_blake3-990c4c0cfb4eaa87.rlib(fleek_blake3-990c4c0cfb4eaa87.fleek_blake3.4f11e9370af31773-cgu.0.rcgu.o):/home/ubuntu/.cargo/registry/src/index.crates.io-6f17d22bba15001f/fleek-blake3-1.4.1/src/ffi_neon.rs:45: first defined here\n"})}),"\n",(0,t.jsxs)(n.p,{children:["As a result of the ",(0,t.jsx)(n.a,{href:"https://github.com/ryssroad/fleek-aarch64-build",children:"research"})," by the community member ",(0,t.jsx)(n.a,{href:"https://github.com/ryssroad",children:"ryssroad"}),", the following solution was shared."]}),"\n",(0,t.jsxs)(n.p,{children:["Open the ",(0,t.jsx)(n.code,{children:"cargo.toml"})," file in ",(0,t.jsx)(n.code,{children:"~/fleek-network/lightning/Cargo.toml"})," and find the ",(0,t.jsx)(n.code,{children:"lto"})," key."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"lto = true\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Change the ",(0,t.jsx)(n.code,{children:"lto"})," key value from ",(0,t.jsx)(n.code,{children:"true"})," to ",(0,t.jsx)(n.code,{children:"thin"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:'...\n[profile.release]\n# currently enabled, may increase build time, but runtime faster, can set to `"thin"`.\nlto = "thin"\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Set ",(0,t.jsx)(n.code,{children:"RUSTFLAGS"})," on build, as follows:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:'RUSTFLAGS="-Clink-arg=-Wl,--allow-multiple-definition" cargo +stable build --release \n'})}),"\n",(0,t.jsxs)(n.p,{children:["Once the build completes, you should find the generated binary ",(0,t.jsx)(n.code,{children:"lightning-node"})," under the directory ",(0,t.jsx)(n.code,{children:"~/fleek-network/lightning/target/release/lightning-node"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"As an example, execute:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"~/fleek-network/lightning/target/release/lightning-node help\n"})}),"\n",(0,t.jsx)(n.p,{children:"To find the help output:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-sh",children:"Usage: lightning-node [OPTIONS] \n\nCommands:\n run Start the node\n keys Handle keys\n print-config Print the loaded configuration\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -c, --config Path to the toml configuration file [default: ~/.lightning/config.toml]\n --with-mock-consensus Determines that we should be using the mock consensus backend\n -v... Increases the level of verbosity (the max level is -vvv)\n --log-location Print code location on console logs\n -h, --help Print help\n -V, --version Print version\n"})}),"\n",(0,t.jsx)(s.Z,{name:"Road aka @road",image:"https://github.com/ryssroad.png",title:"Community member",url:"https://github.com/ryssroad",communityMember:"true"})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},3872:(e,n,r)=>{r.d(n,{Z:()=>i});r(7294);var t=r(5893);const i=e=>{let{image:n,name:r,title:i,url:s,communityMember:l=!1}=e;return(0,t.jsx)("section",{className:"author_card",children:(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"avatar",children:(0,t.jsx)("a",{href:s,target:"_blank",alt:r,children:(0,t.jsx)("img",{src:n,alt:r})})}),(0,t.jsxs)("div",{children:[(0,t.jsx)("span",{className:"name",children:(0,t.jsx)("a",{href:s,target:"_blank",alt:r,children:r})}),(0,t.jsx)("span",{className:"title",children:i}),(0,t.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,t.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>l});var t=r(7294);const i={},s=t.createContext(i);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d8be0e5a.c6714554.js b/assets/js/d8be0e5a.7310f9e2.js similarity index 99% rename from assets/js/d8be0e5a.c6714554.js rename to assets/js/d8be0e5a.7310f9e2.js index e28bfb99d..73e868399 100644 --- a/assets/js/d8be0e5a.c6714554.js +++ b/assets/js/d8be0e5a.7310f9e2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1706],{4751:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var r=i(5893),t=i(1151),s=i(3872);const l={title:"Error linking with cc",slug:"error-linking-with-cc-failed-exist-status-1",hide_title:!0,tags:["references","help","update","upgrade","fix"]},a=void 0,c={id:"Lightning CLI/error-linking-with-cc-failed",title:"Error linking with cc",description:"Check if CPU is supported",source:"@site/references/Lightning CLI/error-linking-with-cc-failed.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/error-linking-with-cc-failed-exist-status-1",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/error-linking-with-cc-failed.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"update",permalink:"/references/tags/update"},{label:"upgrade",permalink:"/references/tags/upgrade"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Error linking with cc",slug:"error-linking-with-cc-failed-exist-status-1",hide_title:!0,tags:["references","help","update","upgrade","fix"]},sidebar:"defaultSidebar",previous:{title:"Error building on ARM64",permalink:"/references/Lightning CLI/error-building-on-arm64"},next:{title:"File permissions and Ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership"}},o={},d=[{value:"Check if CPU is supported",id:"check-if-cpu-is-supported",level:2},{value:"Linking with cc error",id:"linking-with-cc-error",level:2},{value:"Update",id:"update",level:2},{value:"Install gcc:",id:"install-gcc",level:2},{value:"Remove previous installation files",id:"remove-previous-installation-files",level:2},{value:"Run the installation script",id:"run-the-installation-script",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"check-if-cpu-is-supported",children:"Check if CPU is supported"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"uname -i\n"})}),"\n",(0,r.jsxs)(n.admonition,{title:"WARNING",type:"caution",children:[(0,r.jsxs)(n.p,{children:["Given the ",(0,r.jsx)(n.a,{href:"https://docs.fleek.network/docs/node/requirements/#specs",children:"CPU requirements"}),", currently we're mainly supporting ",(0,r.jsx)(n.code,{children:"GenuineIntel"})," and there have been reports of failure to build the binary on ",(0,r.jsx)(n.code,{children:"AMD"}),". The ",(0,r.jsx)(n.code,{children:"ARM64"})," is a different architecture, thus not supported, but there has been some community contributions in that regard, find it in the reference ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/error-building-on-arm64",children:"error building on ARM64"}),"."]}),(0,r.jsxs)(n.p,{children:["Any contribution or feedback to provide support is appreciated. Feel free to let us know on our ",(0,r.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord channel"}),"."]})]}),"\n",(0,r.jsx)(n.h2,{id:"linking-with-cc-error",children:"Linking with cc error"}),"\n",(0,r.jsxs)(n.p,{children:["A user who finds the error ",(0,r.jsx)(n.code,{children:"linking with cc failed"}),", will have to install the required dependencies."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"error: linking with `cc` failed: exit status: 1\nerror: could not compile `fleek-service-ping-example` (lib) due to previous error\n"})}),"\n",(0,r.jsx)(n.h2,{id:"update",children:"Update"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo apt-get update\n"})}),"\n",(0,r.jsxs)(n.h2,{id:"install-gcc",children:["Install ",(0,r.jsx)(n.code,{children:"gcc"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo apt-get install gcc\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-previous-installation-files",children:"Remove previous installation files"}),"\n",(0,r.jsxs)(n.p,{children:["You can re-run the installation process. If you are using the assisted installer, it'll complain that the source code directory already exists. Since you've probably cloned the source code repository locally, you'll have to remove it manually. If you need help, find the instructions in the ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/uninstall-lightning-node",children:"reference"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"run-the-installation-script",children:"Run the installation script"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Alternatively, read the ",(0,r.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation instructions"})," for more information."]}),"\n",(0,r.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,i)=>{i.d(n,{Z:()=>t});i(7294);var r=i(5893);const t=e=>{let{image:n,name:i,title:t,url:s,communityMember:l=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:s,target:"_blank",alt:i,children:(0,r.jsx)("img",{src:n,alt:i})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:s,target:"_blank",alt:i,children:i})}),(0,r.jsx)("span",{className:"title",children:t}),(0,r.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>l});var r=i(7294);const t={},s=r.createContext(t);function l(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[1706],{4751:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var r=i(5893),t=i(1151),s=i(3872);const l={title:"Error linking with cc",slug:"error-linking-with-cc-failed-exist-status-1",hide_title:!0,tags:["references","help","update","upgrade","fix"]},a=void 0,c={id:"Lightning CLI/error-linking-with-cc-failed",title:"Error linking with cc",description:"Check if CPU is supported",source:"@site/references/Lightning CLI/error-linking-with-cc-failed.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/error-linking-with-cc-failed-exist-status-1",permalink:"/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/error-linking-with-cc-failed.md",tags:[{label:"references",permalink:"/references/tags/references"},{label:"help",permalink:"/references/tags/help"},{label:"update",permalink:"/references/tags/update"},{label:"upgrade",permalink:"/references/tags/upgrade"},{label:"fix",permalink:"/references/tags/fix"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Error linking with cc",slug:"error-linking-with-cc-failed-exist-status-1",hide_title:!0,tags:["references","help","update","upgrade","fix"]},sidebar:"defaultSidebar",previous:{title:"Error building on ARM64",permalink:"/references/Lightning CLI/error-building-on-arm64"},next:{title:"File permissions and Ownership",permalink:"/references/Lightning CLI/file-permissions-and-ownership"}},o={},d=[{value:"Check if CPU is supported",id:"check-if-cpu-is-supported",level:2},{value:"Linking with cc error",id:"linking-with-cc-error",level:2},{value:"Update",id:"update",level:2},{value:"Install gcc:",id:"install-gcc",level:2},{value:"Remove previous installation files",id:"remove-previous-installation-files",level:2},{value:"Run the installation script",id:"run-the-installation-script",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"check-if-cpu-is-supported",children:"Check if CPU is supported"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"uname -i\n"})}),"\n",(0,r.jsxs)(n.admonition,{title:"WARNING",type:"caution",children:[(0,r.jsxs)(n.p,{children:["Given the ",(0,r.jsx)(n.a,{href:"https://docs.fleek.network/docs/node/requirements/#specs",children:"CPU requirements"}),", currently we're mainly supporting ",(0,r.jsx)(n.code,{children:"GenuineIntel"})," and there have been reports of failure to build the binary on ",(0,r.jsx)(n.code,{children:"AMD"}),". The ",(0,r.jsx)(n.code,{children:"ARM64"})," is a different architecture, thus not supported, but there has been some community contributions in that regard, find it in the reference ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/error-building-on-arm64",children:"error building on ARM64"}),"."]}),(0,r.jsxs)(n.p,{children:["Any contribution or feedback to provide support is appreciated. Feel free to let us know on our ",(0,r.jsx)(n.a,{href:"https://discord.gg/fleekxyz",children:"Discord channel"}),"."]})]}),"\n",(0,r.jsx)(n.h2,{id:"linking-with-cc-error",children:"Linking with cc error"}),"\n",(0,r.jsxs)(n.p,{children:["A user who finds the error ",(0,r.jsx)(n.code,{children:"linking with cc failed"}),", will have to install the required dependencies."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"error: linking with `cc` failed: exit status: 1\nerror: could not compile `fleek-service-ping-example` (lib) due to previous error\n"})}),"\n",(0,r.jsx)(n.h2,{id:"update",children:"Update"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo apt-get update\n"})}),"\n",(0,r.jsxs)(n.h2,{id:"install-gcc",children:["Install ",(0,r.jsx)(n.code,{children:"gcc"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"sudo apt-get install gcc\n"})}),"\n",(0,r.jsx)(n.h2,{id:"remove-previous-installation-files",children:"Remove previous installation files"}),"\n",(0,r.jsxs)(n.p,{children:["You can re-run the installation process. If you are using the assisted installer, it'll complain that the source code directory already exists. Since you've probably cloned the source code repository locally, you'll have to remove it manually. If you need help, find the instructions in the ",(0,r.jsx)(n.a,{href:"/references/Lightning%20CLI/uninstall-lightning-node",children:"reference"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"run-the-installation-script",children:"Run the installation script"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:"curl https://get.fleek.network | bash\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Alternatively, read the ",(0,r.jsx)(n.a,{href:"/docs/node/install#manual-installation",children:"manual installation instructions"})," for more information."]}),"\n",(0,r.jsx)(s.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},3872:(e,n,i)=>{i.d(n,{Z:()=>t});i(7294);var r=i(5893);const t=e=>{let{image:n,name:i,title:t,url:s,communityMember:l=!1}=e;return(0,r.jsx)("section",{className:"author_card",children:(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"avatar",children:(0,r.jsx)("a",{href:s,target:"_blank",alt:i,children:(0,r.jsx)("img",{src:n,alt:i})})}),(0,r.jsxs)("div",{children:[(0,r.jsx)("span",{className:"name",children:(0,r.jsx)("a",{href:s,target:"_blank",alt:i,children:i})}),(0,r.jsx)("span",{className:"title",children:t}),(0,r.jsxs)("span",{className:"discord",children:[l?"Join our community on":"Got questions? Find us on"," ",(0,r.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>l});var r=i(7294);const t={},s=r.createContext(t);function l(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd2b74dc.23e85cda.js b/assets/js/fd2b74dc.e63dbaac.js similarity index 98% rename from assets/js/fd2b74dc.23e85cda.js rename to assets/js/fd2b74dc.e63dbaac.js index 909b2bdec..305a23ece 100644 --- a/assets/js/fd2b74dc.23e85cda.js +++ b/assets/js/fd2b74dc.e63dbaac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[4846],{949:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var s=n(5893),o=n(1151),r=n(3872);const i={title:"Keys not found",slug:"keys-not-found",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},a=void 0,d={id:"Lightning CLI/keys-not-found",title:"Keys not found",description:"Node key does not exist",source:"@site/references/Lightning CLI/keys-not-found.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/keys-not-found",permalink:"/references/Lightning CLI/keys-not-found",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/keys-not-found.md",tags:[{label:"keystore",permalink:"/references/tags/keystore"},{label:"lost keys",permalink:"/references/tags/lost-keys"},{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"}],version:"current",lastUpdatedAt:1699029404,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Keys not found",slug:"keys-not-found",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},sidebar:"defaultSidebar",previous:{title:"Frequently used commands for Native setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup"},next:{title:"Backing up the keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore"}},l={},c=[{value:"Node key does not exist",id:"node-key-does-not-exist",level:2}];function h(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"node-key-does-not-exist",children:"Node key does not exist"}),"\n",(0,s.jsx)(t.p,{children:'When watching the Fleek Network Lightning service log output, you find the "Node key does not exist" message placed recursively. As follows:'}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"thread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\nthread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\n"})}),"\n",(0,s.jsxs)(t.p,{children:["If you haven't deleted the keystore and can locate it, it's due to how the service is being run. As a user can delegate (sudo) the execution of the process to ",(0,s.jsx)(t.strong,{children:"root"}),", the location of the keystore differs on runtime."]}),"\n",(0,s.jsxs)(t.p,{children:["To learn more about how file permissions and ownership work, you're advised to read the reference document ",(0,s.jsx)(t.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"here"}),"."]}),"\n",(0,s.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>o});n(7294);var s=n(5893);const o=e=>{let{image:t,name:n,title:o,url:r,communityMember:i=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:n,children:(0,s.jsx)("img",{src:t,alt:n})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:n,children:n})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var s=n(7294);const o={},r=s.createContext(o);function i(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocta=self.webpackChunkdocta||[]).push([[4846],{949:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var s=n(5893),o=n(1151),r=n(3872);const i={title:"Keys not found",slug:"keys-not-found",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},a=void 0,d={id:"Lightning CLI/keys-not-found",title:"Keys not found",description:"Node key does not exist",source:"@site/references/Lightning CLI/keys-not-found.md",sourceDirName:"Lightning CLI",slug:"/Lightning CLI/keys-not-found",permalink:"/references/Lightning CLI/keys-not-found",draft:!1,unlisted:!1,editUrl:"https://github.com/fleek-network/fleek-network-docs/edit/main/references/Lightning CLI/keys-not-found.md",tags:[{label:"keystore",permalink:"/references/tags/keystore"},{label:"lost keys",permalink:"/references/tags/lost-keys"},{label:"ownership",permalink:"/references/tags/ownership"},{label:"file permissions",permalink:"/references/tags/file-permissions"}],version:"current",lastUpdatedAt:1699030086,formattedLastUpdatedAt:"Nov 3, 2023",frontMatter:{title:"Keys not found",slug:"keys-not-found",hide_title:!0,tags:["keystore","lost keys","ownership","file permissions"]},sidebar:"defaultSidebar",previous:{title:"Frequently used commands for Native setup",permalink:"/references/Lightning CLI/frequently-used-commands-for-native-setup"},next:{title:"Backing up the keystore",permalink:"/references/Lightning CLI/backing-up-the-keystore"}},l={},c=[{value:"Node key does not exist",id:"node-key-does-not-exist",level:2}];function h(e){const t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h2,{id:"node-key-does-not-exist",children:"Node key does not exist"}),"\n",(0,s.jsx)(t.p,{children:'When watching the Fleek Network Lightning service log output, you find the "Node key does not exist" message placed recursively. As follows:'}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-sh",children:"thread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\nthread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\n"})}),"\n",(0,s.jsxs)(t.p,{children:["If you haven't deleted the keystore and can locate it, it's due to how the service is being run. As a user can delegate (sudo) the execution of the process to ",(0,s.jsx)(t.strong,{children:"root"}),", the location of the keystore differs on runtime."]}),"\n",(0,s.jsxs)(t.p,{children:["To learn more about how file permissions and ownership work, you're advised to read the reference document ",(0,s.jsx)(t.a,{href:"/references/Lightning%20CLI/file-permissions-and-ownership",children:"here"}),"."]}),"\n",(0,s.jsx)(r.Z,{name:"Helder Oliveira",image:"https://github.com/heldrida.png",title:"Software Developer + DX",url:"https://github.com/heldrida"})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},3872:(e,t,n)=>{n.d(t,{Z:()=>o});n(7294);var s=n(5893);const o=e=>{let{image:t,name:n,title:o,url:r,communityMember:i=!1}=e;return(0,s.jsx)("section",{className:"author_card",children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"avatar",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:n,children:(0,s.jsx)("img",{src:t,alt:n})})}),(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"name",children:(0,s.jsx)("a",{href:r,target:"_blank",alt:n,children:n})}),(0,s.jsx)("span",{className:"title",children:o}),(0,s.jsxs)("span",{className:"discord",children:[i?"Join our community on":"Got questions? Find us on"," ",(0,s.jsx)("a",{href:"https://discord.gg/fleekxyz",target:"_blank",children:"discord!"})]})]})]})})}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var s=n(7294);const o={},r=s.createContext(o);function i(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.6753361e.js b/assets/js/runtime~main.30c2e4d7.js similarity index 71% rename from assets/js/runtime~main.6753361e.js rename to assets/js/runtime~main.30c2e4d7.js index 63012dd40..7afaf5f86 100644 --- a/assets/js/runtime~main.6753361e.js +++ b/assets/js/runtime~main.30c2e4d7.js @@ -1 +1 @@ -(()=>{"use strict";var e,d,f,a,c,b={},t={};function r(e){var d=t[e];if(void 0!==d)return d.exports;var f=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(f.exports,f,f.exports,r),f.loaded=!0,f.exports}r.m=b,r.c=t,e=[],r.O=(d,f,a,c)=>{if(!f){var b=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](f[o])))?f.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[f,a,c]},r.n=e=>{var d=e&&e.__esModule?()=>e.default:()=>e;return r.d(d,{a:d}),d},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var b={};d=d||[null,f({}),f([]),f(f)];for(var t=2&a&&e;"object"==typeof t&&!~d.indexOf(t);t=f(t))Object.getOwnPropertyNames(t).forEach((d=>b[d]=()=>e[d]));return b.default=()=>e,r.d(c,b),c},r.d=(e,d)=>{for(var f in d)r.o(d,f)&&!r.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:d[f]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((d,f)=>(r.f[f](e,d),d)),[])),r.u=e=>"assets/js/"+({4:"779cc1e8",11:"3a6297ac",53:"935f2afb",71:"51f2bfad",173:"48e81e49",327:"b696d13b",373:"9f1c3232",382:"8def2dd5",387:"7ceaa645",402:"49b5e83d",469:"3b168dbd",533:"b2b675dd",551:"b4f44b9b",554:"7aba1839",555:"433ff3d6",572:"caaedc90",581:"a626c4f3",659:"5d08f08d",663:"0ea1f268",706:"719c0fd7",747:"155c1e74",801:"631037e5",814:"95f4d37c",909:"5437f376",920:"b8c37621",982:"f3d7f34e",1025:"98f9308d",1138:"64d03520",1251:"7aefc753",1263:"74ec46b4",1345:"c3f5dd14",1354:"ceabd901",1433:"ae70e824",1474:"75d8af72",1476:"b9b7817e",1477:"b2f554cd",1498:"29b62a39",1510:"29b83576",1517:"166b5465",1563:"39e94577",1611:"fa7546af",1706:"d8be0e5a",1713:"a7023ddc",1771:"564044f9",1837:"ce321ae3",1955:"9722e053",1984:"51d5b592",2023:"d464210a",2027:"d1d29319",2114:"b5954e33",2126:"b40daf0f",2170:"02f62b30",2214:"399f21a8",2235:"3290fbc2",2240:"469c924f",2260:"4035650f",2386:"93df2695",2421:"86c3bd1d",2450:"e6a08407",2501:"5559e604",2517:"8a92e787",2535:"814f3328",2564:"1366d7ae",2702:"1c14429f",2800:"4247aede",2908:"48857ff6",2918:"d7d81bf6",3012:"aa81941d",3023:"d1b78a4d",3089:"a6aa9e1f",3116:"4061bfd3",3131:"f893ec16",3189:"2adfdcac",3218:"6ccb158e",3236:"cc9d5bf1",3237:"1df93b7f",3336:"84cbd6c9",3343:"09ac38f0",3396:"6be32138",3503:"af6a11bf",3608:"9e4087bc",3707:"f02c0d6e",3719:"f41bce02",3751:"3720c009",3863:"53ca291c",4013:"01a85c17",4034:"ec98ad91",4063:"44969bae",4121:"55960ee5",4327:"07f20919",4356:"a9a76bf7",4368:"a94703ab",4402:"40aeb86f",4451:"3f3a03c1",4508:"35a7e2bf",4530:"2218035b",4537:"21f2cabf",4541:"da8f35c6",4556:"68b99ecd",4679:"6e965365",4708:"e10957d6",4713:"9f7d0305",4749:"616ee580",4785:"b03a0ac1",4788:"f6807fb4",4819:"85d6e74d",4826:"50f02954",4846:"fd2b74dc",4872:"54436d06",4888:"f50a4147",4939:"b8466c91",5049:"9cc140f3",5075:"0dffb83e",5081:"4beaa780",5094:"763344b9",5120:"ffcb1b32",5136:"6cbb3cde",5204:"45ac3af8",5318:"581d5240",5347:"f9537533",5466:"43ee1886",5522:"8428fe34",5530:"d16f6fc6",5548:"d23df0ea",5602:"35230925",5649:"7b667a7f",5767:"b249ed45",5844:"ad04e600",5888:"da002ab0",6074:"a771de40",6103:"ccc49370",6272:"4d7007b2",6296:"4c9535f7",6310:"cc8e0b88",6353:"7b9de75f",6362:"749619b5",6410:"514cab6e",6446:"2a6b0b88",6461:"f4fd4511",6476:"5a9491fe",6577:"965d240c",6601:"179183ba",6669:"3f90f51b",6696:"45e1a117",6699:"9bd69ffc",6726:"de225737",6788:"187c6361",6798:"fa69a7f4",6854:"8cf21e85",6926:"27528755",6939:"f3f8ecb0",6971:"c377a04b",6980:"b02525a9",7055:"26b85cb6",7091:"e91f52c1",7136:"a13e0645",7147:"2730e145",7216:"08ded6db",7249:"153c226b",7310:"ffc337e7",7400:"2ddc9f52",7536:"6f8964f3",7563:"c222de09",7649:"0359c679",7706:"b35f1b7f",7796:"a50e2e4f",7804:"ecfddbd4",7813:"933a69d3",7918:"17896441",7920:"1a4e3797",8005:"82893666",8059:"84e08f43",8132:"2e0a4d25",8256:"79055aff",8318:"9bca08cf",8427:"143de299",8489:"19f79f7b",8518:"a7bd4aaa",8567:"5ef0bdde",8578:"445e9e2a",8610:"6875c492",8644:"dc2776f2",8668:"866d553a",8747:"39574d2e",8754:"bea6e15b",8934:"0fbdd4ac",8942:"5ec90731",9021:"2baa5a9a",9062:"7b788087",9188:"bd59af11",9267:"08dd5264",9316:"180ee354",9320:"665f164c",9335:"00309d1b",9336:"3f0cec70",9395:"ce4635d7",9511:"4c027320",9513:"4a821728",9649:"90decb6d",9661:"5e95c892",9707:"dd97a9bc",9743:"fcc63351",9752:"5b6134d1",9804:"5d38c936",9822:"13986d62",9829:"5bc389a1",9847:"45c86e35",9854:"1d8a5d15",9924:"df203c0f",9981:"ae013ba6",9995:"e331fbd7"}[e]||e)+"."+{4:"b5e33d5d",11:"348b248b",53:"3edf634b",71:"03938b9f",130:"2448291a",173:"5ac56e34",327:"67d6433c",373:"754ab62e",382:"8faef833",387:"42ff94cb",402:"bb00ad8f",469:"d8580674",533:"3685267b",551:"24b75469",554:"8f38c854",555:"093c7d9e",572:"0c254351",581:"dee5a042",659:"5c7abe18",663:"b27098e9",706:"6c3d8003",747:"c60231fe",801:"adb20c2c",814:"0a40e7b8",909:"f15b7afc",920:"3fb7580a",982:"36b0c123",1025:"90313cd9",1138:"6f24231a",1251:"93358e1b",1263:"5a8f5ef0",1345:"74ce3614",1354:"23077e58",1426:"8a7f4119",1433:"0e6f6d61",1474:"0db0b71a",1476:"8ebc058f",1477:"61d2597d",1498:"b6b221f6",1510:"57da8952",1517:"f98909ca",1563:"85f019bf",1611:"7af1c866",1706:"c6714554",1713:"e95d897a",1771:"b5bab01d",1772:"9796a666",1837:"8a69b8f3",1955:"1c14cb03",1984:"eb15ccfd",2023:"3e507ebe",2027:"bcaebf14",2114:"3422a378",2126:"2f5ab135",2170:"11304d9c",2214:"420d866d",2235:"dd92ec9c",2240:"9a76c610",2260:"9316e754",2386:"300a96e1",2421:"9115d118",2450:"9629e8eb",2501:"11d96201",2517:"00004987",2535:"01f98a18",2564:"4fb5075d",2702:"cb58d9d4",2800:"df1864bc",2908:"ba1d9243",2918:"6664e938",3012:"a884d55b",3023:"51b5e6ba",3089:"e40508bd",3116:"29aa95b8",3131:"d295f0cb",3189:"3c37a29a",3218:"5162cfe7",3236:"8bf22a24",3237:"4902629f",3336:"64b11bb4",3343:"0e47b6a8",3396:"327ad97b",3503:"050de1e1",3608:"7fa7842e",3707:"a68a515b",3719:"7f0e4028",3751:"30b055b5",3863:"7e6b99d7",4013:"d4221160",4034:"f6dcd324",4063:"ff574e4c",4121:"afc475ed",4327:"72a0ea98",4356:"6ebee837",4368:"1851859d",4402:"fce7036d",4451:"c14b64e9",4508:"71209370",4530:"a68c5f9c",4537:"c9ad8d38",4541:"faa1df34",4556:"9b719a2d",4679:"33a8784c",4708:"c579463f",4713:"ff0deaac",4749:"6ddee81a",4785:"5e843cb3",4788:"4f260ebf",4819:"6280433f",4826:"c6206aff",4846:"23e85cda",4872:"4d56aa06",4888:"0bd0271c",4939:"bdc01329",5049:"d46c2c0c",5075:"98f34a7e",5081:"9c9386ab",5094:"3fc871db",5120:"d590406b",5136:"6db4a7cc",5204:"cf7a9fd9",5318:"4f96a3e4",5347:"8676b1d1",5466:"d81e37f7",5522:"9593ce54",5530:"dcce69ae",5548:"c3394e4f",5602:"dcdddd7b",5649:"8a480976",5767:"56c5c530",5844:"80dbb210",5888:"4e4f882b",6074:"cd72cf12",6103:"152e84b2",6272:"0c4a09fe",6296:"c64ce4e5",6310:"32340495",6353:"61af48f1",6362:"eabd0923",6410:"8af2ed2b",6446:"01c63236",6461:"35512f65",6476:"79d386e5",6577:"50a7d323",6601:"6a924c3e",6669:"c63e3c64",6696:"340acc3e",6699:"96d0dc87",6726:"a2e520ac",6788:"df90bd39",6798:"48858406",6854:"f316391c",6926:"432f62b4",6939:"4317feec",6945:"bd8076fe",6971:"b8a439ee",6980:"4e924af7",7055:"70653ead",7091:"d3ff2d82",7136:"94a2c40f",7147:"c1bd76ce",7216:"a1e0dc68",7249:"722fc636",7310:"5f4be381",7400:"1d8c6c02",7536:"a1c6e6fd",7563:"301bcc1f",7649:"3ca6e3fb",7706:"ffee93db",7796:"08511bd9",7804:"21bb1ad5",7813:"ba52a263",7874:"f6f729a5",7918:"dbf77ff9",7920:"769d8c18",8005:"1b7a455f",8059:"fd8204f1",8132:"b54bdd52",8256:"33b2b3c8",8318:"cd5bdade",8427:"d3a097ff",8489:"f4de5e9e",8518:"928fb9e5",8567:"da8175a7",8578:"e4a8d31a",8610:"463ee9a3",8644:"a0c19ad7",8668:"db30cd0a",8747:"d1d6cecf",8754:"422e763d",8894:"62e3afaa",8934:"514e2af7",8942:"4eab081d",9021:"f25a88f1",9062:"8948d3eb",9188:"82aec483",9267:"7ebeebf6",9316:"b69fc369",9320:"eea293a2",9335:"9df700f1",9336:"f7c10106",9395:"2f6e9cd8",9511:"9f0993f7",9513:"3a30c2cd",9649:"17716680",9661:"3e88c822",9707:"8892f4a2",9743:"947aff8c",9752:"ec4f85a2",9804:"01ab4afd",9822:"c1425471",9829:"226207a6",9847:"17e3d245",9854:"8054019c",9924:"7f1db2f5",9981:"851e7143",9995:"29ba16bf"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,d)=>Object.prototype.hasOwnProperty.call(e,d),a={},c="docta:",r.l=(e,d,f,b)=>{if(a[e])a[e].push(d);else{var t,o;if(void 0!==f)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=a[e];if(delete a[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(f))),d)return d(f)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"7918",27528755:"6926",35230925:"5602",82893666:"8005","779cc1e8":"4","3a6297ac":"11","935f2afb":"53","51f2bfad":"71","48e81e49":"173",b696d13b:"327","9f1c3232":"373","8def2dd5":"382","7ceaa645":"387","49b5e83d":"402","3b168dbd":"469",b2b675dd:"533",b4f44b9b:"551","7aba1839":"554","433ff3d6":"555",caaedc90:"572",a626c4f3:"581","5d08f08d":"659","0ea1f268":"663","719c0fd7":"706","155c1e74":"747","631037e5":"801","95f4d37c":"814","5437f376":"909",b8c37621:"920",f3d7f34e:"982","98f9308d":"1025","64d03520":"1138","7aefc753":"1251","74ec46b4":"1263",c3f5dd14:"1345",ceabd901:"1354",ae70e824:"1433","75d8af72":"1474",b9b7817e:"1476",b2f554cd:"1477","29b62a39":"1498","29b83576":"1510","166b5465":"1517","39e94577":"1563",fa7546af:"1611",d8be0e5a:"1706",a7023ddc:"1713","564044f9":"1771",ce321ae3:"1837","9722e053":"1955","51d5b592":"1984",d464210a:"2023",d1d29319:"2027",b5954e33:"2114",b40daf0f:"2126","02f62b30":"2170","399f21a8":"2214","3290fbc2":"2235","469c924f":"2240","4035650f":"2260","93df2695":"2386","86c3bd1d":"2421",e6a08407:"2450","5559e604":"2501","8a92e787":"2517","814f3328":"2535","1366d7ae":"2564","1c14429f":"2702","4247aede":"2800","48857ff6":"2908",d7d81bf6:"2918",aa81941d:"3012",d1b78a4d:"3023",a6aa9e1f:"3089","4061bfd3":"3116",f893ec16:"3131","2adfdcac":"3189","6ccb158e":"3218",cc9d5bf1:"3236","1df93b7f":"3237","84cbd6c9":"3336","09ac38f0":"3343","6be32138":"3396",af6a11bf:"3503","9e4087bc":"3608",f02c0d6e:"3707",f41bce02:"3719","3720c009":"3751","53ca291c":"3863","01a85c17":"4013",ec98ad91:"4034","44969bae":"4063","55960ee5":"4121","07f20919":"4327",a9a76bf7:"4356",a94703ab:"4368","40aeb86f":"4402","3f3a03c1":"4451","35a7e2bf":"4508","2218035b":"4530","21f2cabf":"4537",da8f35c6:"4541","68b99ecd":"4556","6e965365":"4679",e10957d6:"4708","9f7d0305":"4713","616ee580":"4749",b03a0ac1:"4785",f6807fb4:"4788","85d6e74d":"4819","50f02954":"4826",fd2b74dc:"4846","54436d06":"4872",f50a4147:"4888",b8466c91:"4939","9cc140f3":"5049","0dffb83e":"5075","4beaa780":"5081","763344b9":"5094",ffcb1b32:"5120","6cbb3cde":"5136","45ac3af8":"5204","581d5240":"5318",f9537533:"5347","43ee1886":"5466","8428fe34":"5522",d16f6fc6:"5530",d23df0ea:"5548","7b667a7f":"5649",b249ed45:"5767",ad04e600:"5844",da002ab0:"5888",a771de40:"6074",ccc49370:"6103","4d7007b2":"6272","4c9535f7":"6296",cc8e0b88:"6310","7b9de75f":"6353","749619b5":"6362","514cab6e":"6410","2a6b0b88":"6446",f4fd4511:"6461","5a9491fe":"6476","965d240c":"6577","179183ba":"6601","3f90f51b":"6669","45e1a117":"6696","9bd69ffc":"6699",de225737:"6726","187c6361":"6788",fa69a7f4:"6798","8cf21e85":"6854",f3f8ecb0:"6939",c377a04b:"6971",b02525a9:"6980","26b85cb6":"7055",e91f52c1:"7091",a13e0645:"7136","2730e145":"7147","08ded6db":"7216","153c226b":"7249",ffc337e7:"7310","2ddc9f52":"7400","6f8964f3":"7536",c222de09:"7563","0359c679":"7649",b35f1b7f:"7706",a50e2e4f:"7796",ecfddbd4:"7804","933a69d3":"7813","1a4e3797":"7920","84e08f43":"8059","2e0a4d25":"8132","79055aff":"8256","9bca08cf":"8318","143de299":"8427","19f79f7b":"8489",a7bd4aaa:"8518","5ef0bdde":"8567","445e9e2a":"8578","6875c492":"8610",dc2776f2:"8644","866d553a":"8668","39574d2e":"8747",bea6e15b:"8754","0fbdd4ac":"8934","5ec90731":"8942","2baa5a9a":"9021","7b788087":"9062",bd59af11:"9188","08dd5264":"9267","180ee354":"9316","665f164c":"9320","00309d1b":"9335","3f0cec70":"9336",ce4635d7:"9395","4c027320":"9511","4a821728":"9513","90decb6d":"9649","5e95c892":"9661",dd97a9bc:"9707",fcc63351:"9743","5b6134d1":"9752","5d38c936":"9804","13986d62":"9822","5bc389a1":"9829","45c86e35":"9847","1d8a5d15":"9854",df203c0f:"9924",ae013ba6:"9981",e331fbd7:"9995"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(d,f)=>{var a=r.o(e,d)?e[d]:void 0;if(0!==a)if(a)f.push(a[2]);else if(/^(1303|532)$/.test(d))e[d]=0;else{var c=new Promise(((f,c)=>a=e[d]=[f,c]));f.push(a[2]=c);var b=r.p+r.u(d),t=new Error;r.l(b,(f=>{if(r.o(e,d)&&(0!==(a=e[d])&&(e[d]=void 0),a)){var c=f&&("load"===f.type?"missing":f.type),b=f&&f.target&&f.target.src;t.message="Loading chunk "+d+" failed.\n("+c+": "+b+")",t.name="ChunkLoadError",t.type=c,t.request=b,a[1](t)}}),"chunk-"+d,d)}},r.O.j=d=>0===e[d];var d=(d,f)=>{var a,c,b=f[0],t=f[1],o=f[2],n=0;if(b.some((d=>0!==e[d]))){for(a in t)r.o(t,a)&&(r.m[a]=t[a]);if(o)var i=o(r)}for(d&&d(f);n{"use strict";var e,a,d,f,c,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,f,c)=>{if(!d){var b=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[d,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(c,b),c},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({4:"779cc1e8",11:"3a6297ac",53:"935f2afb",71:"51f2bfad",173:"48e81e49",327:"b696d13b",373:"9f1c3232",382:"8def2dd5",387:"7ceaa645",402:"49b5e83d",469:"3b168dbd",533:"b2b675dd",551:"b4f44b9b",554:"7aba1839",555:"433ff3d6",572:"caaedc90",581:"a626c4f3",659:"5d08f08d",663:"0ea1f268",706:"719c0fd7",747:"155c1e74",801:"631037e5",814:"95f4d37c",909:"5437f376",920:"b8c37621",982:"f3d7f34e",1025:"98f9308d",1138:"64d03520",1251:"7aefc753",1263:"74ec46b4",1345:"c3f5dd14",1354:"ceabd901",1433:"ae70e824",1474:"75d8af72",1476:"b9b7817e",1477:"b2f554cd",1498:"29b62a39",1510:"29b83576",1517:"166b5465",1563:"39e94577",1611:"fa7546af",1706:"d8be0e5a",1713:"a7023ddc",1771:"564044f9",1837:"ce321ae3",1955:"9722e053",1984:"51d5b592",2023:"d464210a",2027:"d1d29319",2114:"b5954e33",2126:"b40daf0f",2170:"02f62b30",2214:"399f21a8",2235:"3290fbc2",2240:"469c924f",2260:"4035650f",2386:"93df2695",2421:"86c3bd1d",2450:"e6a08407",2501:"5559e604",2517:"8a92e787",2535:"814f3328",2564:"1366d7ae",2702:"1c14429f",2800:"4247aede",2908:"48857ff6",2918:"d7d81bf6",3012:"aa81941d",3023:"d1b78a4d",3089:"a6aa9e1f",3116:"4061bfd3",3131:"f893ec16",3189:"2adfdcac",3218:"6ccb158e",3236:"cc9d5bf1",3237:"1df93b7f",3336:"84cbd6c9",3343:"09ac38f0",3396:"6be32138",3503:"af6a11bf",3608:"9e4087bc",3707:"f02c0d6e",3719:"f41bce02",3751:"3720c009",3863:"53ca291c",4013:"01a85c17",4034:"ec98ad91",4063:"44969bae",4121:"55960ee5",4327:"07f20919",4356:"a9a76bf7",4368:"a94703ab",4402:"40aeb86f",4451:"3f3a03c1",4508:"35a7e2bf",4530:"2218035b",4537:"21f2cabf",4541:"da8f35c6",4556:"68b99ecd",4679:"6e965365",4708:"e10957d6",4713:"9f7d0305",4749:"616ee580",4785:"b03a0ac1",4788:"f6807fb4",4819:"85d6e74d",4826:"50f02954",4846:"fd2b74dc",4872:"54436d06",4888:"f50a4147",4939:"b8466c91",5049:"9cc140f3",5075:"0dffb83e",5081:"4beaa780",5094:"763344b9",5120:"ffcb1b32",5136:"6cbb3cde",5204:"45ac3af8",5318:"581d5240",5347:"f9537533",5466:"43ee1886",5522:"8428fe34",5530:"d16f6fc6",5548:"d23df0ea",5602:"35230925",5649:"7b667a7f",5767:"b249ed45",5844:"ad04e600",5888:"da002ab0",6074:"a771de40",6103:"ccc49370",6272:"4d7007b2",6296:"4c9535f7",6310:"cc8e0b88",6353:"7b9de75f",6362:"749619b5",6410:"514cab6e",6446:"2a6b0b88",6461:"f4fd4511",6476:"5a9491fe",6577:"965d240c",6601:"179183ba",6669:"3f90f51b",6696:"45e1a117",6699:"9bd69ffc",6726:"de225737",6788:"187c6361",6798:"fa69a7f4",6854:"8cf21e85",6926:"27528755",6939:"f3f8ecb0",6971:"c377a04b",6980:"b02525a9",7055:"26b85cb6",7091:"e91f52c1",7136:"a13e0645",7147:"2730e145",7216:"08ded6db",7249:"153c226b",7310:"ffc337e7",7400:"2ddc9f52",7536:"6f8964f3",7563:"c222de09",7649:"0359c679",7706:"b35f1b7f",7796:"a50e2e4f",7804:"ecfddbd4",7813:"933a69d3",7918:"17896441",7920:"1a4e3797",8005:"82893666",8059:"84e08f43",8132:"2e0a4d25",8256:"79055aff",8318:"9bca08cf",8427:"143de299",8489:"19f79f7b",8518:"a7bd4aaa",8567:"5ef0bdde",8578:"445e9e2a",8610:"6875c492",8644:"dc2776f2",8668:"866d553a",8747:"39574d2e",8754:"bea6e15b",8934:"0fbdd4ac",8942:"5ec90731",9021:"2baa5a9a",9062:"7b788087",9188:"bd59af11",9267:"08dd5264",9316:"180ee354",9320:"665f164c",9335:"00309d1b",9336:"3f0cec70",9395:"ce4635d7",9511:"4c027320",9513:"4a821728",9649:"90decb6d",9661:"5e95c892",9707:"dd97a9bc",9743:"fcc63351",9752:"5b6134d1",9804:"5d38c936",9822:"13986d62",9829:"5bc389a1",9847:"45c86e35",9854:"1d8a5d15",9924:"df203c0f",9981:"ae013ba6",9995:"e331fbd7"}[e]||e)+"."+{4:"b5e33d5d",11:"348b248b",53:"3edf634b",71:"03938b9f",130:"2448291a",173:"5ac56e34",327:"67d6433c",373:"754ab62e",382:"8faef833",387:"42ff94cb",402:"bb00ad8f",469:"d8580674",533:"3685267b",551:"24b75469",554:"8f38c854",555:"093c7d9e",572:"0c254351",581:"dee5a042",659:"5c7abe18",663:"b27098e9",706:"6c3d8003",747:"c60231fe",801:"adb20c2c",814:"0a40e7b8",909:"1e096079",920:"3fb7580a",982:"36b0c123",1025:"51072b62",1138:"6f24231a",1251:"5ad99947",1263:"5a8f5ef0",1345:"74ce3614",1354:"23077e58",1426:"8a7f4119",1433:"0e6f6d61",1474:"0db0b71a",1476:"8ebc058f",1477:"021cd732",1498:"333f4be5",1510:"29335de2",1517:"f98909ca",1563:"85f019bf",1611:"7af1c866",1706:"7310f9e2",1713:"e95d897a",1771:"b5bab01d",1772:"9796a666",1837:"8a69b8f3",1955:"ea8653ae",1984:"eb15ccfd",2023:"3e507ebe",2027:"bcaebf14",2114:"3422a378",2126:"2f5ab135",2170:"11304d9c",2214:"420d866d",2235:"dd92ec9c",2240:"9a76c610",2260:"9316e754",2386:"300a96e1",2421:"9115d118",2450:"9629e8eb",2501:"11d96201",2517:"69bc4b07",2535:"01f98a18",2564:"4fb5075d",2702:"85e85158",2800:"df1864bc",2908:"ba1d9243",2918:"63c91c8c",3012:"a884d55b",3023:"a6a62d4b",3089:"e40508bd",3116:"29aa95b8",3131:"d295f0cb",3189:"3c37a29a",3218:"5162cfe7",3236:"8bf22a24",3237:"4902629f",3336:"64b11bb4",3343:"0e47b6a8",3396:"7384c59d",3503:"050de1e1",3608:"7fa7842e",3707:"a68a515b",3719:"7f0e4028",3751:"30b055b5",3863:"7e6b99d7",4013:"d4221160",4034:"f6dcd324",4063:"ff574e4c",4121:"afc475ed",4327:"72a0ea98",4356:"6ebee837",4368:"1851859d",4402:"488d6a51",4451:"c14b64e9",4508:"71209370",4530:"a68c5f9c",4537:"c9ad8d38",4541:"faa1df34",4556:"9b719a2d",4679:"33a8784c",4708:"c579463f",4713:"ff0deaac",4749:"6ddee81a",4785:"5e843cb3",4788:"4f260ebf",4819:"6280433f",4826:"c6206aff",4846:"e63dbaac",4872:"4d56aa06",4888:"0bd0271c",4939:"bdc01329",5049:"d46c2c0c",5075:"98f34a7e",5081:"9c9386ab",5094:"3fc871db",5120:"d590406b",5136:"6db4a7cc",5204:"cf7a9fd9",5318:"4f96a3e4",5347:"8676b1d1",5466:"d81e37f7",5522:"9593ce54",5530:"dcce69ae",5548:"9d31279d",5602:"dcdddd7b",5649:"8a480976",5767:"401d8f19",5844:"80dbb210",5888:"4e4f882b",6074:"cd72cf12",6103:"152e84b2",6272:"d4e0db29",6296:"e7e0c96d",6310:"32340495",6353:"61af48f1",6362:"eabd0923",6410:"8af2ed2b",6446:"01c63236",6461:"35512f65",6476:"79d386e5",6577:"50a7d323",6601:"6a924c3e",6669:"c63e3c64",6696:"340acc3e",6699:"96d0dc87",6726:"a2e520ac",6788:"df90bd39",6798:"48858406",6854:"f316391c",6926:"432f62b4",6939:"4317feec",6945:"bd8076fe",6971:"b8a439ee",6980:"4e924af7",7055:"7aca1da0",7091:"d3ff2d82",7136:"94a2c40f",7147:"adec3d4f",7216:"a1e0dc68",7249:"722fc636",7310:"5f4be381",7400:"1d8c6c02",7536:"a1c6e6fd",7563:"301bcc1f",7649:"3ca6e3fb",7706:"969eb0cf",7796:"08511bd9",7804:"21bb1ad5",7813:"ba52a263",7874:"f6f729a5",7918:"dbf77ff9",7920:"769d8c18",8005:"1b7a455f",8059:"fd8204f1",8132:"b54bdd52",8256:"33b2b3c8",8318:"cd5bdade",8427:"d3a097ff",8489:"fe682020",8518:"928fb9e5",8567:"da8175a7",8578:"f29f39d7",8610:"463ee9a3",8644:"a0c19ad7",8668:"8ce6bf03",8747:"d1d6cecf",8754:"422e763d",8894:"62e3afaa",8934:"514e2af7",8942:"4eab081d",9021:"f25a88f1",9062:"8948d3eb",9188:"82aec483",9267:"7ebeebf6",9316:"b69fc369",9320:"bbb4b5f5",9335:"9df700f1",9336:"f7c10106",9395:"2f6e9cd8",9511:"9f0993f7",9513:"3a30c2cd",9649:"17716680",9661:"3e88c822",9707:"8892f4a2",9743:"947aff8c",9752:"cacd68da",9804:"01ab4afd",9822:"c1425471",9829:"95833e6d",9847:"17e3d245",9854:"e18454dc",9924:"7f1db2f5",9981:"851e7143",9995:"29ba16bf"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="docta:",r.l=(e,a,d,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(d))),a)return a(d)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"7918",27528755:"6926",35230925:"5602",82893666:"8005","779cc1e8":"4","3a6297ac":"11","935f2afb":"53","51f2bfad":"71","48e81e49":"173",b696d13b:"327","9f1c3232":"373","8def2dd5":"382","7ceaa645":"387","49b5e83d":"402","3b168dbd":"469",b2b675dd:"533",b4f44b9b:"551","7aba1839":"554","433ff3d6":"555",caaedc90:"572",a626c4f3:"581","5d08f08d":"659","0ea1f268":"663","719c0fd7":"706","155c1e74":"747","631037e5":"801","95f4d37c":"814","5437f376":"909",b8c37621:"920",f3d7f34e:"982","98f9308d":"1025","64d03520":"1138","7aefc753":"1251","74ec46b4":"1263",c3f5dd14:"1345",ceabd901:"1354",ae70e824:"1433","75d8af72":"1474",b9b7817e:"1476",b2f554cd:"1477","29b62a39":"1498","29b83576":"1510","166b5465":"1517","39e94577":"1563",fa7546af:"1611",d8be0e5a:"1706",a7023ddc:"1713","564044f9":"1771",ce321ae3:"1837","9722e053":"1955","51d5b592":"1984",d464210a:"2023",d1d29319:"2027",b5954e33:"2114",b40daf0f:"2126","02f62b30":"2170","399f21a8":"2214","3290fbc2":"2235","469c924f":"2240","4035650f":"2260","93df2695":"2386","86c3bd1d":"2421",e6a08407:"2450","5559e604":"2501","8a92e787":"2517","814f3328":"2535","1366d7ae":"2564","1c14429f":"2702","4247aede":"2800","48857ff6":"2908",d7d81bf6:"2918",aa81941d:"3012",d1b78a4d:"3023",a6aa9e1f:"3089","4061bfd3":"3116",f893ec16:"3131","2adfdcac":"3189","6ccb158e":"3218",cc9d5bf1:"3236","1df93b7f":"3237","84cbd6c9":"3336","09ac38f0":"3343","6be32138":"3396",af6a11bf:"3503","9e4087bc":"3608",f02c0d6e:"3707",f41bce02:"3719","3720c009":"3751","53ca291c":"3863","01a85c17":"4013",ec98ad91:"4034","44969bae":"4063","55960ee5":"4121","07f20919":"4327",a9a76bf7:"4356",a94703ab:"4368","40aeb86f":"4402","3f3a03c1":"4451","35a7e2bf":"4508","2218035b":"4530","21f2cabf":"4537",da8f35c6:"4541","68b99ecd":"4556","6e965365":"4679",e10957d6:"4708","9f7d0305":"4713","616ee580":"4749",b03a0ac1:"4785",f6807fb4:"4788","85d6e74d":"4819","50f02954":"4826",fd2b74dc:"4846","54436d06":"4872",f50a4147:"4888",b8466c91:"4939","9cc140f3":"5049","0dffb83e":"5075","4beaa780":"5081","763344b9":"5094",ffcb1b32:"5120","6cbb3cde":"5136","45ac3af8":"5204","581d5240":"5318",f9537533:"5347","43ee1886":"5466","8428fe34":"5522",d16f6fc6:"5530",d23df0ea:"5548","7b667a7f":"5649",b249ed45:"5767",ad04e600:"5844",da002ab0:"5888",a771de40:"6074",ccc49370:"6103","4d7007b2":"6272","4c9535f7":"6296",cc8e0b88:"6310","7b9de75f":"6353","749619b5":"6362","514cab6e":"6410","2a6b0b88":"6446",f4fd4511:"6461","5a9491fe":"6476","965d240c":"6577","179183ba":"6601","3f90f51b":"6669","45e1a117":"6696","9bd69ffc":"6699",de225737:"6726","187c6361":"6788",fa69a7f4:"6798","8cf21e85":"6854",f3f8ecb0:"6939",c377a04b:"6971",b02525a9:"6980","26b85cb6":"7055",e91f52c1:"7091",a13e0645:"7136","2730e145":"7147","08ded6db":"7216","153c226b":"7249",ffc337e7:"7310","2ddc9f52":"7400","6f8964f3":"7536",c222de09:"7563","0359c679":"7649",b35f1b7f:"7706",a50e2e4f:"7796",ecfddbd4:"7804","933a69d3":"7813","1a4e3797":"7920","84e08f43":"8059","2e0a4d25":"8132","79055aff":"8256","9bca08cf":"8318","143de299":"8427","19f79f7b":"8489",a7bd4aaa:"8518","5ef0bdde":"8567","445e9e2a":"8578","6875c492":"8610",dc2776f2:"8644","866d553a":"8668","39574d2e":"8747",bea6e15b:"8754","0fbdd4ac":"8934","5ec90731":"8942","2baa5a9a":"9021","7b788087":"9062",bd59af11:"9188","08dd5264":"9267","180ee354":"9316","665f164c":"9320","00309d1b":"9335","3f0cec70":"9336",ce4635d7:"9395","4c027320":"9511","4a821728":"9513","90decb6d":"9649","5e95c892":"9661",dd97a9bc:"9707",fcc63351:"9743","5b6134d1":"9752","5d38c936":"9804","13986d62":"9822","5bc389a1":"9829","45c86e35":"9847","1d8a5d15":"9854",df203c0f:"9924",ae013ba6:"9981",e331fbd7:"9995"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)d.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((d,c)=>f=e[a]=[d,c]));d.push(f[2]=c);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+b+")",t.name="ChunkLoadError",t.type=c,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var f,c,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(d);n - + diff --git a/blog/atom.xml b/blog/atom.xml index 8b8b5181c..54ea4853c 100644 --- a/blog/atom.xml +++ b/blog/atom.xml @@ -2,7 +2,7 @@ https://docs.fleek.network/blog Fleek Network Docs | Decentralized Edge Platform Blog - 2023-11-03T16:36:44.000Z + 2023-11-03T16:48:06.000Z https://github.com/jpmonette/feed Fleek Network Docs | Decentralized Edge Platform Blog @@ -12,7 +12,7 @@ <![CDATA[Bloom Filters and Cuckoo Filters for Cache Summarization]]> https://docs.fleek.network/blog/bloom-and-cuckoo-filters-for-cache-summarization - 2023-11-03T16:36:44.000Z + 2023-11-03T16:48:06.000Z Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.

Background​

diff --git a/blog/bloom-and-cuckoo-filters-for-cache-summarization/index.html b/blog/bloom-and-cuckoo-filters-for-cache-summarization/index.html index 43c2c6f5c..829919561 100644 --- a/blog/bloom-and-cuckoo-filters-for-cache-summarization/index.html +++ b/blog/bloom-and-cuckoo-filters-for-cache-summarization/index.html @@ -3,7 +3,7 @@ -Bloom Filters and Cuckoo Filters for Cache Summarization | Fleek Network Docs | Decentralized Edge Platform +Bloom Filters and Cuckoo Filters for Cache Summarization | Fleek Network Docs | Decentralized Edge Platform @@ -13,13 +13,13 @@ - + -

Bloom Filters and Cuckoo Filters for Cache Summarization

· 11 min read
Matthias Wright

Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.

+

Bloom Filters and Cuckoo Filters for Cache Summarization

· 11 min read
Matthias Wright

Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.

Background​

Nodes on Fleek Network currently use Counting Bloom filters to summarize their cached content. These cache summaries are exchanged with other nodes in order to facilitate content routing.

If a particular node does not store a requested piece of content, it can use the Bloom filters that it received from its peers to check if a peer stores the requested content.

diff --git a/blog/feed.json b/blog/feed.json index 0c3d9b4d4..1677920a4 100644 --- a/blog/feed.json +++ b/blog/feed.json @@ -10,7 +10,7 @@ "url": "https://docs.fleek.network/blog/bloom-and-cuckoo-filters-for-cache-summarization", "title": "Bloom Filters and Cuckoo Filters for Cache Summarization", "summary": "Summary of our experiment informing whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters.", - "date_modified": "2023-11-03T16:36:44.000Z", + "date_modified": "2023-11-03T16:48:06.000Z", "author": { "name": "Matthias Wright", "url": "https://github.com/matthias-wright" diff --git a/blog/index.html b/blog/index.html index 5f9be6829..20797826a 100644 --- a/blog/index.html +++ b/blog/index.html @@ -13,12 +13,12 @@ - + -
+
\ No newline at end of file diff --git a/blog/rss.xml b/blog/rss.xml index 34100e746..cfa867563 100644 --- a/blog/rss.xml +++ b/blog/rss.xml @@ -4,7 +4,7 @@ Fleek Network Docs | Decentralized Edge Platform Blog https://docs.fleek.network/blog Fleek Network Docs | Decentralized Edge Platform Blog - Fri, 03 Nov 2023 16:36:44 GMT + Fri, 03 Nov 2023 16:48:06 GMT https://validator.w3.org/feed/docs/rss2.html https://github.com/jpmonette/feed en @@ -13,7 +13,7 @@ <![CDATA[Bloom Filters and Cuckoo Filters for Cache Summarization]]> https://docs.fleek.network/blog/bloom-and-cuckoo-filters-for-cache-summarization https://docs.fleek.network/blog/bloom-and-cuckoo-filters-for-cache-summarization - Fri, 03 Nov 2023 16:36:44 GMT + Fri, 03 Nov 2023 16:48:06 GMT Disclaimer: This is not a general comparison between Bloom filters and Cuckoo filters. This blog post summarizes some of the experiments we conducted to decide whether or not we should replace our implementation of Counting Bloom filters with Cuckoo filters, for a specific use case.

Background​

diff --git a/blog/tags/blog/index.html b/blog/tags/blog/index.html index f217ba113..dbe3f509a 100644 --- a/blog/tags/blog/index.html +++ b/blog/tags/blog/index.html @@ -13,12 +13,12 @@ - + -

One post tagged with "blog"

View All Tags
+

One post tagged with "blog"

View All Tags
\ No newline at end of file diff --git a/blog/tags/content-routing/index.html b/blog/tags/content-routing/index.html index 7eff16bff..1bd1f8cdf 100644 --- a/blog/tags/content-routing/index.html +++ b/blog/tags/content-routing/index.html @@ -13,12 +13,12 @@ - + -

One post tagged with "content routing"

View All Tags
+

One post tagged with "content routing"

View All Tags
\ No newline at end of file diff --git a/blog/tags/engineering/index.html b/blog/tags/engineering/index.html index 8ff57ddf5..a799bdb31 100644 --- a/blog/tags/engineering/index.html +++ b/blog/tags/engineering/index.html @@ -13,12 +13,12 @@ - + -

One post tagged with "engineering"

View All Tags
+

One post tagged with "engineering"

View All Tags
\ No newline at end of file diff --git a/blog/tags/fleek-network/index.html b/blog/tags/fleek-network/index.html index 58fbca64c..b4df746f1 100644 --- a/blog/tags/fleek-network/index.html +++ b/blog/tags/fleek-network/index.html @@ -13,12 +13,12 @@ - + -

One post tagged with "fleek network"

View All Tags
+

One post tagged with "fleek network"

View All Tags
\ No newline at end of file diff --git a/blog/tags/index.html b/blog/tags/index.html index 3db6e18e5..c6f94d7a3 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/Open-source/code-of-conduct/index.html b/docs/Open-source/code-of-conduct/index.html index 369fa17c8..8d66fdffe 100644 --- a/docs/Open-source/code-of-conduct/index.html +++ b/docs/Open-source/code-of-conduct/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/Open-source/contributing/index.html b/docs/Open-source/contributing/index.html index 49739dd25..61b2b57b1 100644 --- a/docs/Open-source/contributing/index.html +++ b/docs/Open-source/contributing/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/Open-source/index.html b/docs/Open-source/index.html index a9db9d92e..fab919e0e 100644 --- a/docs/Open-source/index.html +++ b/docs/Open-source/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/Open-source/repositories/index.html b/docs/Open-source/repositories/index.html index 744f8aa35..44a210e94 100644 --- a/docs/Open-source/repositories/index.html +++ b/docs/Open-source/repositories/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/develop/client/index.html b/docs/develop/client/index.html index 270697b8d..9ea8e2bb4 100644 --- a/docs/develop/client/index.html +++ b/docs/develop/client/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/develop/json-rpc/index.html b/docs/develop/json-rpc/index.html index 25b07f7e9..ac250f89f 100644 --- a/docs/develop/json-rpc/index.html +++ b/docs/develop/json-rpc/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/develop/overview/index.html b/docs/develop/overview/index.html index c23b73769..061a6f1ae 100644 --- a/docs/develop/overview/index.html +++ b/docs/develop/overview/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/develop/service-development/index.html b/docs/develop/service-development/index.html index bf9b83204..03396504f 100644 --- a/docs/develop/service-development/index.html +++ b/docs/develop/service-development/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/index.html b/docs/index.html index 03edb2cbf..627abea04 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/delivery-acknowledgements/index.html b/docs/learn/delivery-acknowledgements/index.html index 83327480f..b92e4e898 100644 --- a/docs/learn/delivery-acknowledgements/index.html +++ b/docs/learn/delivery-acknowledgements/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/developers/index.html b/docs/learn/developers/index.html index 272e273cc..2fb1878c1 100644 --- a/docs/learn/developers/index.html +++ b/docs/learn/developers/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/introduction/index.html b/docs/learn/introduction/index.html index 8bb268c6b..0b9f769fd 100644 --- a/docs/learn/introduction/index.html +++ b/docs/learn/introduction/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/services/index.html b/docs/learn/services/index.html index 79cc26d52..9cec3a3c5 100644 --- a/docs/learn/services/index.html +++ b/docs/learn/services/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/the-network/index.html b/docs/learn/the-network/index.html index 69f8cd21b..f1a510a24 100644 --- a/docs/learn/the-network/index.html +++ b/docs/learn/the-network/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/learn/token-and-economics/index.html b/docs/learn/token-and-economics/index.html index 583d62af3..4de3fb24f 100644 --- a/docs/learn/token-and-economics/index.html +++ b/docs/learn/token-and-economics/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/analyzing-logs/index.html b/docs/node/analyzing-logs/index.html index 88d31c48b..2e80dd8ac 100644 --- a/docs/node/analyzing-logs/index.html +++ b/docs/node/analyzing-logs/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/configuration/index.html b/docs/node/configuration/index.html index 13232aadc..284c6d2c7 100644 --- a/docs/node/configuration/index.html +++ b/docs/node/configuration/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/diagnostics/index.html b/docs/node/diagnostics/index.html index 75203e207..74ab5004e 100644 --- a/docs/node/diagnostics/index.html +++ b/docs/node/diagnostics/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/health-check/index.html b/docs/node/health-check/index.html index 5a2be56d4..d274594f7 100644 --- a/docs/node/health-check/index.html +++ b/docs/node/health-check/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/install/index.html b/docs/node/install/index.html index 90fa5db31..7288dbf55 100644 --- a/docs/node/install/index.html +++ b/docs/node/install/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/lightning-cli/index.html b/docs/node/lightning-cli/index.html index d87737e8e..c8975464f 100644 --- a/docs/node/lightning-cli/index.html +++ b/docs/node/lightning-cli/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/overview/index.html b/docs/node/overview/index.html index 6555de275..c31bb14d3 100644 --- a/docs/node/overview/index.html +++ b/docs/node/overview/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/requirements/index.html b/docs/node/requirements/index.html index 47ebb5543..587e8f28d 100644 --- a/docs/node/requirements/index.html +++ b/docs/node/requirements/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/systemd-service/index.html b/docs/node/systemd-service/index.html index a29b363e8..06e0155bb 100644 --- a/docs/node/systemd-service/index.html +++ b/docs/node/systemd-service/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/node/testnet-onboarding/index.html b/docs/node/testnet-onboarding/index.html index 65ae61563..abe2659ed 100644 --- a/docs/node/testnet-onboarding/index.html +++ b/docs/node/testnet-onboarding/index.html @@ -13,13 +13,13 @@ - + -
Important

The Testnet Phase 1 has finished on Thursday, Oct. 26th. Phase 1 turned out to be an enormous success. Seeing 5k+ nodes successfully running across the network and demonstrating that Fleek Network is capable of being just as performant as web2 cdn/edge platforms and, with further optimizations, potentially even more performant. Dive into the full performance data and key analysis in the Phase 1 recap blog.

If you'd like to participate in the next Testnet Phase, follow us on Discord, Twitter, or our Blog releases.

+
Important

The Testnet Phase 1 has finished on Thursday, Oct. 26th. Phase 1 turned out to be an enormous success. Seeing 5k+ nodes successfully running across the network and demonstrating that Fleek Network is capable of being just as performant as web2 cdn/edge platforms and, with further optimizations, potentially even more performant. Dive into the full performance data and key analysis in the Phase 1 recap blog. If you'd like to participate in the Testnet Phase 2, follow us on Discord, Twitter, or our blog posts.

Testnet Phase 1:​

Following the successful completion of Fleek Network Testnet Phase 0, the core development team has been actively implementing the next set of core protocol functionalities, which include services, the reward's system, the broadcaster/synchronizer, as well as all identified improvements and fixes found during that phase.

Prerequesites​

@@ -90,6 +90,8 @@

tip

You can get the Node Public Key and Server IP Address quick by using the node details script described in the section.

Report to us by sharing the details about via our discord troubleshooting channel.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+

Can I shut down the node after Testnet completion?​

+

Once the Testnet finishes, it's not necessary to keep the node active. Furthermore, as the Testnet identity and its related stake hold no intrinsic value other than for testing purposes, you can delete them. Of course that if you want to learn how to back up or restore keys, you can read about how to manage the key store and keep the keys.

+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/docs/roadmap/index.html b/docs/roadmap/index.html index 2bff4713e..fbaa8b31d 100644 --- a/docs/roadmap/index.html +++ b/docs/roadmap/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/about/index.html b/docs/tags/about/index.html index caa44a14a..b5659cb09 100644 --- a/docs/tags/about/index.html +++ b/docs/tags/about/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/algorithms/index.html b/docs/tags/algorithms/index.html index 7c91e0ccf..7f0d4798d 100644 --- a/docs/tags/algorithms/index.html +++ b/docs/tags/algorithms/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/architecture/index.html b/docs/tags/architecture/index.html index 7b6ac0b2d..22eccd711 100644 --- a/docs/tags/architecture/index.html +++ b/docs/tags/architecture/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/awards/index.html b/docs/tags/awards/index.html index 337f2ca75..6d8651c03 100644 --- a/docs/tags/awards/index.html +++ b/docs/tags/awards/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/build/index.html b/docs/tags/build/index.html index 411948e63..77de44d24 100644 --- a/docs/tags/build/index.html +++ b/docs/tags/build/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/cdn/index.html b/docs/tags/cdn/index.html index a14ec397c..948b3385f 100644 --- a/docs/tags/cdn/index.html +++ b/docs/tags/cdn/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/cli/index.html b/docs/tags/cli/index.html index 355285576..9a270abe8 100644 --- a/docs/tags/cli/index.html +++ b/docs/tags/cli/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/client/index.html b/docs/tags/client/index.html index af1fad63c..fd7e18342 100644 --- a/docs/tags/client/index.html +++ b/docs/tags/client/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/code-of-conduct/index.html b/docs/tags/code-of-conduct/index.html index bb5d9caa2..eaf71fd98 100644 --- a/docs/tags/code-of-conduct/index.html +++ b/docs/tags/code-of-conduct/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/codebase/index.html b/docs/tags/codebase/index.html index 7f160650d..443927612 100644 --- a/docs/tags/codebase/index.html +++ b/docs/tags/codebase/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/command-line-interface/index.html b/docs/tags/command-line-interface/index.html index 96df0dac1..9b347c4be 100644 --- a/docs/tags/command-line-interface/index.html +++ b/docs/tags/command-line-interface/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/compile/index.html b/docs/tags/compile/index.html index 16936d49d..002904796 100644 --- a/docs/tags/compile/index.html +++ b/docs/tags/compile/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/configuration/index.html b/docs/tags/configuration/index.html index 89b534c76..113d5ea4b 100644 --- a/docs/tags/configuration/index.html +++ b/docs/tags/configuration/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/consensus/index.html b/docs/tags/consensus/index.html index 717f17031..c9b200847 100644 --- a/docs/tags/consensus/index.html +++ b/docs/tags/consensus/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/contribute/index.html b/docs/tags/contribute/index.html index 2e524f2d6..4f69590c7 100644 --- a/docs/tags/contribute/index.html +++ b/docs/tags/contribute/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/control/index.html b/docs/tags/control/index.html index 64476e478..796ef864c 100644 --- a/docs/tags/control/index.html +++ b/docs/tags/control/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/decentralization/index.html b/docs/tags/decentralization/index.html index 5a2abb3ba..b32a087fc 100644 --- a/docs/tags/decentralization/index.html +++ b/docs/tags/decentralization/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/develop/index.html b/docs/tags/develop/index.html index 86487e7c8..c14585a90 100644 --- a/docs/tags/develop/index.html +++ b/docs/tags/develop/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/diagnostic/index.html b/docs/tags/diagnostic/index.html index deaeb245b..64a1e2301 100644 --- a/docs/tags/diagnostic/index.html +++ b/docs/tags/diagnostic/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/diagnostics/index.html b/docs/tags/diagnostics/index.html index 40f46ae76..073ec0ff2 100644 --- a/docs/tags/diagnostics/index.html +++ b/docs/tags/diagnostics/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/economics/index.html b/docs/tags/economics/index.html index f982136a5..67ec8236c 100644 --- a/docs/tags/economics/index.html +++ b/docs/tags/economics/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/edge-network/index.html b/docs/tags/edge-network/index.html index bed4877a5..13b10f033 100644 --- a/docs/tags/edge-network/index.html +++ b/docs/tags/edge-network/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/edge-platform/index.html b/docs/tags/edge-platform/index.html index b41f4ae04..4d57496e9 100644 --- a/docs/tags/edge-platform/index.html +++ b/docs/tags/edge-platform/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/fleek-network/index.html b/docs/tags/fleek-network/index.html index 75698c54d..373ade401 100644 --- a/docs/tags/fleek-network/index.html +++ b/docs/tags/fleek-network/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/getting-started/index.html b/docs/tags/getting-started/index.html index 0b2caada3..c83c80c7e 100644 --- a/docs/tags/getting-started/index.html +++ b/docs/tags/getting-started/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/git/index.html b/docs/tags/git/index.html index 9066383a9..078a3dcdc 100644 --- a/docs/tags/git/index.html +++ b/docs/tags/git/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/guide/index.html b/docs/tags/guide/index.html index bc1ea5e36..95616ef18 100644 --- a/docs/tags/guide/index.html +++ b/docs/tags/guide/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/healthcheck/index.html b/docs/tags/healthcheck/index.html index 81971403a..aa349f96c 100644 --- a/docs/tags/healthcheck/index.html +++ b/docs/tags/healthcheck/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/incentives/index.html b/docs/tags/incentives/index.html index 90a037db6..a818f9011 100644 --- a/docs/tags/incentives/index.html +++ b/docs/tags/incentives/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/index.html b/docs/tags/index.html index b218c4952..c5716d170 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/learn/index.html b/docs/tags/learn/index.html index 929e68c5d..de1c5a41b 100644 --- a/docs/tags/learn/index.html +++ b/docs/tags/learn/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/lgtn/index.html b/docs/tags/lgtn/index.html index 493e7ab34..b8b0a75c6 100644 --- a/docs/tags/lgtn/index.html +++ b/docs/tags/lgtn/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/lightning/index.html b/docs/tags/lightning/index.html index fa89766e6..5ea9fec99 100644 --- a/docs/tags/lightning/index.html +++ b/docs/tags/lightning/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/logs/index.html b/docs/tags/logs/index.html index 46282e0a4..94d343be5 100644 --- a/docs/tags/logs/index.html +++ b/docs/tags/logs/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/manage/index.html b/docs/tags/manage/index.html index 483e59c45..dacec10f8 100644 --- a/docs/tags/manage/index.html +++ b/docs/tags/manage/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/manual/index.html b/docs/tags/manual/index.html index d316da6f6..a3c9f67b4 100644 --- a/docs/tags/manual/index.html +++ b/docs/tags/manual/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/node-status/index.html b/docs/tags/node-status/index.html index ce6c03192..64115e986 100644 --- a/docs/tags/node-status/index.html +++ b/docs/tags/node-status/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/onboarding/index.html b/docs/tags/onboarding/index.html index b89e9ecaa..d9580ff78 100644 --- a/docs/tags/onboarding/index.html +++ b/docs/tags/onboarding/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/open-source/index.html b/docs/tags/open-source/index.html index ecda2dee9..a3148c250 100644 --- a/docs/tags/open-source/index.html +++ b/docs/tags/open-source/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/permissionless/index.html b/docs/tags/permissionless/index.html index e83049e25..a43827393 100644 --- a/docs/tags/permissionless/index.html +++ b/docs/tags/permissionless/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/phases/index.html b/docs/tags/phases/index.html index bcfde67ce..dae5e48f1 100644 --- a/docs/tags/phases/index.html +++ b/docs/tags/phases/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/pledge/index.html b/docs/tags/pledge/index.html index c35ee47ea..288868386 100644 --- a/docs/tags/pledge/index.html +++ b/docs/tags/pledge/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/ports/index.html b/docs/tags/ports/index.html index 97a081ca6..86eb09783 100644 --- a/docs/tags/ports/index.html +++ b/docs/tags/ports/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/protocol/index.html b/docs/tags/protocol/index.html index cfff87f00..30c5d1f92 100644 --- a/docs/tags/protocol/index.html +++ b/docs/tags/protocol/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/repository/index.html b/docs/tags/repository/index.html index 59e23ae6f..0f7a94ba5 100644 --- a/docs/tags/repository/index.html +++ b/docs/tags/repository/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/reputation/index.html b/docs/tags/reputation/index.html index 1e3e743b4..c60beb210 100644 --- a/docs/tags/reputation/index.html +++ b/docs/tags/reputation/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/requirements/index.html b/docs/tags/requirements/index.html index 976d981d1..ff338319b 100644 --- a/docs/tags/requirements/index.html +++ b/docs/tags/requirements/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/rewards/index.html b/docs/tags/rewards/index.html index db0149402..f624db031 100644 --- a/docs/tags/rewards/index.html +++ b/docs/tags/rewards/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/roadmap/index.html b/docs/tags/roadmap/index.html index 6948f274b..670ee2198 100644 --- a/docs/tags/roadmap/index.html +++ b/docs/tags/roadmap/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/rpc/index.html b/docs/tags/rpc/index.html index 1c672d731..1ff036f0d 100644 --- a/docs/tags/rpc/index.html +++ b/docs/tags/rpc/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/rust-dependencies/index.html b/docs/tags/rust-dependencies/index.html index b7fb3b1ff..d35767eef 100644 --- a/docs/tags/rust-dependencies/index.html +++ b/docs/tags/rust-dependencies/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/sdk/index.html b/docs/tags/sdk/index.html index d9ce5553d..0c7f75a50 100644 --- a/docs/tags/sdk/index.html +++ b/docs/tags/sdk/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/server/index.html b/docs/tags/server/index.html index 10ea00351..aeaf16d3a 100644 --- a/docs/tags/server/index.html +++ b/docs/tags/server/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/services/index.html b/docs/tags/services/index.html index 1b13d3491..6e1e9160e 100644 --- a/docs/tags/services/index.html +++ b/docs/tags/services/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/snarks/index.html b/docs/tags/snarks/index.html index 26f71dc87..90dbc3c5b 100644 --- a/docs/tags/snarks/index.html +++ b/docs/tags/snarks/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/standards/index.html b/docs/tags/standards/index.html index bf65a87c1..df2fef059 100644 --- a/docs/tags/standards/index.html +++ b/docs/tags/standards/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/systemctl/index.html b/docs/tags/systemctl/index.html index 699db5d43..e5e397c99 100644 --- a/docs/tags/systemctl/index.html +++ b/docs/tags/systemctl/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/systemd/index.html b/docs/tags/systemd/index.html index 252e42a3d..68dd75fcf 100644 --- a/docs/tags/systemd/index.html +++ b/docs/tags/systemd/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/testnet/index.html b/docs/tags/testnet/index.html index 8e6f34aa4..b00046fdf 100644 --- a/docs/tags/testnet/index.html +++ b/docs/tags/testnet/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/token/index.html b/docs/tags/token/index.html index 96d23e34c..840ff3b8b 100644 --- a/docs/tags/token/index.html +++ b/docs/tags/token/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/tokenomics/index.html b/docs/tags/tokenomics/index.html index 8d67947bd..69e78687e 100644 --- a/docs/tags/tokenomics/index.html +++ b/docs/tags/tokenomics/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/toolkit/index.html b/docs/tags/toolkit/index.html index 2d65a1b08..aea049057 100644 --- a/docs/tags/toolkit/index.html +++ b/docs/tags/toolkit/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/verification/index.html b/docs/tags/verification/index.html index 780c099d8..79debd0a4 100644 --- a/docs/tags/verification/index.html +++ b/docs/tags/verification/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/whitepaper/index.html b/docs/tags/whitepaper/index.html index 6e5e11e88..bcf59bf55 100644 --- a/docs/tags/whitepaper/index.html +++ b/docs/tags/whitepaper/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/wizard/index.html b/docs/tags/wizard/index.html index 018ce40cb..e43e47cb9 100644 --- a/docs/tags/wizard/index.html +++ b/docs/tags/wizard/index.html @@ -13,7 +13,7 @@ - + diff --git a/docs/whitepaper/index.html b/docs/whitepaper/index.html index 75e55dbc1..fa61eed30 100644 --- a/docs/whitepaper/index.html +++ b/docs/whitepaper/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/Node Operators/getting-started/index.html b/guides/Node Operators/getting-started/index.html index 7b756bf73..e0f526d11 100644 --- a/guides/Node Operators/getting-started/index.html +++ b/guides/Node Operators/getting-started/index.html @@ -13,7 +13,7 @@ - + @@ -111,6 +111,6 @@

ConclusionFurthermore, we guide you through a step-by-step installation of the network node process, where we pull the source code, build the binary and launch the service.

Finally, we do a quick health check to confirm the status of our node.

Discover more about the project by watching/contributing on GitHub, following us on Twitter, and joining our community Discord for any updates.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/Node Operators/how-to-manage-log-files/index.html b/guides/Node Operators/how-to-manage-log-files/index.html index eb9cbc9e7..9dfec72f5 100644 --- a/guides/Node Operators/how-to-manage-log-files/index.html +++ b/guides/Node Operators/how-to-manage-log-files/index.html @@ -13,7 +13,7 @@ - + @@ -126,6 +126,6 @@

ConclusionThe guide starts by warning us about the stream text messages that the Fleek Network emits by default. As the text data is aggregated and stored in the file system it can lead to fill up the limited available disk space quickly, causing issues to the operation of the system.

To help control it, the journald is introduced, by explaining its role as a centralized message system, that runs alongside the application logs. Then, have it configured to limit the maximum file size, amongst other system-wide settings.

Finally, logrotate is discussed in helping us manage the Fleek Network Lightning application log files by setting it to automatically compress, rename, remove logs for the system admin convenience and saving system's resources.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/Node Operators/managing-the-keystore/index.html b/guides/Node Operators/managing-the-keystore/index.html index 27e1e6d7e..df9234333 100644 --- a/guides/Node Operators/managing-the-keystore/index.html +++ b/guides/Node Operators/managing-the-keystore/index.html @@ -13,7 +13,7 @@ - + @@ -178,6 +178,6 @@

ConclusionIn the future, we'll introduce more advanced topics that will help you improve the knowledge you get from this, but we are glad that you followed this guide and got some comprehension to help you manage the key store.

While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our Discord or by opening a PR in any of our repositories.

Discover more about the project by watching/contributing on Github, following us on Twitter, and joining our community Discord for all the best updates!

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/Node Operators/running-a-node-in-docker/index.html b/guides/Node Operators/running-a-node-in-docker/index.html index cd1e9c6fc..9072e50a0 100644 --- a/guides/Node Operators/running-a-node-in-docker/index.html +++ b/guides/Node Operators/running-a-node-in-docker/index.html @@ -13,7 +13,7 @@ - + @@ -158,6 +158,6 @@

ConclusionWe guided you through the initial installation steps, and how to build a Docker image, which then's used to Docker run a container. Plus, provided lower-level commands, to help you understand other present or advanced use-cases, and also at higher level, offerring simple utility methods.

While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our Discord or by opening a PR in any of our repositories.

Discover more about the project by watching/contributing on Github, following us on Twitter, and joining our community Discord for all the best updates!

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/Node Operators/transfering-setup-ownership/index.html b/guides/Node Operators/transfering-setup-ownership/index.html index f75387ee2..be6d6bd59 100644 --- a/guides/Node Operators/transfering-setup-ownership/index.html +++ b/guides/Node Operators/transfering-setup-ownership/index.html @@ -13,7 +13,7 @@ - + @@ -149,6 +149,6 @@

ConclusionJumped through topics of Systemd service that helps the user manage the service in the Linux environment, which helps keep track of all the processes and threads that are spawned.

We've gone through the step-by-step process to migrate the Fleek Network CLI and Systemd service setup from one user to the other. To keep it short, we decided to go with the use-case of where the migration happens between a root user and a sudoer.

Discover more about the project by watching/contributing on GitHub, following us on Twitter, and joining our community Discord for any updates.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/Node Operators/updating-lightning/index.html b/guides/Node Operators/updating-lightning/index.html index 938328ecb..c2347c809 100644 --- a/guides/Node Operators/updating-lightning/index.html +++ b/guides/Node Operators/updating-lightning/index.html @@ -13,7 +13,7 @@ - + @@ -124,6 +124,6 @@

ConclusionWe have looked into how to pull the changes via Git, and discussed that contributions can introduce new requirements to the host operating system that leads to updates or changes in the documentation–mentioning how hard it is to keep in sync. Explained how to look into the contributions to understand the nature of the change and get hints about new features.

To complete, provided a step-by-step walkthrough the installation and setup process for the Fleek Network Lightning CLI and Systemd service.

Discover more about the project by watching/contributing on GitHub, following us on Twitter, and joining our community Discord for any updates.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/guides/index.html b/guides/index.html index 5471559b3..277c8fe26 100644 --- a/guides/index.html +++ b/guides/index.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

The guides provide step-by-step instructions and descriptions to help understand how and why you'd have to do or execute certain commands or processes.

It differs from the references documentation which serves as a quick direct breakdown of commands and processes without much explanation, as the name implies.

-

To start, find guides by consulting the available categories to locate the content on the sidebar. Our guides are also available as a result when using the search feature located at the very top of the documentation site.

+

To start, find guides by consulting the available categories to locate the content on the sidebar. Our guides are also available as a result when using the search feature located at the very top of the documentation site.

\ No newline at end of file diff --git a/guides/tags/configuration/index.html b/guides/tags/configuration/index.html index ef62d392b..83561eadc 100644 --- a/guides/tags/configuration/index.html +++ b/guides/tags/configuration/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/container/index.html b/guides/tags/container/index.html index 4996d9598..181f0fc89 100644 --- a/guides/tags/container/index.html +++ b/guides/tags/container/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/docker/index.html b/guides/tags/docker/index.html index 66f900b82..5b485ba63 100644 --- a/guides/tags/docker/index.html +++ b/guides/tags/docker/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/edge-computing/index.html b/guides/tags/edge-computing/index.html index f71b96b21..b225a9cfa 100644 --- a/guides/tags/edge-computing/index.html +++ b/guides/tags/edge-computing/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/fleek-network/index.html b/guides/tags/fleek-network/index.html index 929e6f135..8008fadc5 100644 --- a/guides/tags/fleek-network/index.html +++ b/guides/tags/fleek-network/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/getting-started/index.html b/guides/tags/getting-started/index.html index 9afaf9920..b488041f8 100644 --- a/guides/tags/getting-started/index.html +++ b/guides/tags/getting-started/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/guide/index.html b/guides/tags/guide/index.html index b7462fab0..c9f8d0890 100644 --- a/guides/tags/guide/index.html +++ b/guides/tags/guide/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/guides/index.html b/guides/tags/guides/index.html index 22ffe71c6..01c9865a5 100644 --- a/guides/tags/guides/index.html +++ b/guides/tags/guides/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/help/index.html b/guides/tags/help/index.html index aa81ef090..6a0c3a711 100644 --- a/guides/tags/help/index.html +++ b/guides/tags/help/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/index.html b/guides/tags/index.html index 1be56136b..1a11b7535 100644 --- a/guides/tags/index.html +++ b/guides/tags/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/keys/index.html b/guides/tags/keys/index.html index f4d216547..131b3475e 100644 --- a/guides/tags/keys/index.html +++ b/guides/tags/keys/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/keystore/index.html b/guides/tags/keystore/index.html index 34943b4b6..c031d92b4 100644 --- a/guides/tags/keystore/index.html +++ b/guides/tags/keystore/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/logs/index.html b/guides/tags/logs/index.html index 8ac01f4c7..b93c6b626 100644 --- a/guides/tags/logs/index.html +++ b/guides/tags/logs/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/ownership/index.html b/guides/tags/ownership/index.html index a1b6ec78b..1b245ffb7 100644 --- a/guides/tags/ownership/index.html +++ b/guides/tags/ownership/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/private-keys/index.html b/guides/tags/private-keys/index.html index ceae9e207..59e63b9e9 100644 --- a/guides/tags/private-keys/index.html +++ b/guides/tags/private-keys/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/public-keys/index.html b/guides/tags/public-keys/index.html index b88f49946..f829a5b9b 100644 --- a/guides/tags/public-keys/index.html +++ b/guides/tags/public-keys/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/rebuild/index.html b/guides/tags/rebuild/index.html index bbc518558..7b89257e4 100644 --- a/guides/tags/rebuild/index.html +++ b/guides/tags/rebuild/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/setup/index.html b/guides/tags/setup/index.html index dd24445f3..2578c375a 100644 --- a/guides/tags/setup/index.html +++ b/guides/tags/setup/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/transfer/index.html b/guides/tags/transfer/index.html index aeeb155c4..ac224c44c 100644 --- a/guides/tags/transfer/index.html +++ b/guides/tags/transfer/index.html @@ -13,7 +13,7 @@ - + diff --git a/guides/tags/update/index.html b/guides/tags/update/index.html index 135df9fdc..5690a05dd 100644 --- a/guides/tags/update/index.html +++ b/guides/tags/update/index.html @@ -13,7 +13,7 @@ - + diff --git a/index.html b/index.html index bfa890872..9c0c84219 100644 --- a/index.html +++ b/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/Docker/build-and-run-in-docker/index.html b/references/Docker/build-and-run-in-docker/index.html index c0a57e72f..241227e1e 100644 --- a/references/Docker/build-and-run-in-docker/index.html +++ b/references/Docker/build-and-run-in-docker/index.html @@ -13,7 +13,7 @@ - + @@ -65,6 +65,6 @@

Docker Cont

View logs​

To view the logs of a Docker container in real time, use the following command:

sudo docker logs -f lightning-node
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Docker/frequently-used-commands-for-docker-setup/index.html b/references/Docker/frequently-used-commands-for-docker-setup/index.html index 9957a7051..8e1ef7ee4 100644 --- a/references/Docker/frequently-used-commands-for-docker-setup/index.html +++ b/references/Docker/frequently-used-commands-for-docker-setup/index.html @@ -13,7 +13,7 @@ - + @@ -70,6 +70,6 @@

Stop Containe 
sudo docker stop <CONTAINER ID or CONTAINER NAME>

Remove Container​

sudo docker rm <CONTAINER ID or CONTAINER NAME>
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Docker/uninstall-docker-setup/index.html b/references/Docker/uninstall-docker-setup/index.html index ee231720b..8afb4e972 100644 --- a/references/Docker/uninstall-docker-setup/index.html +++ b/references/Docker/uninstall-docker-setup/index.html @@ -13,7 +13,7 @@ - + @@ -65,6 +65,6 @@

Remove the l 
/var/log/lightning

To completely remove the directory run the command:

sudo rm -rf /var/log/lightning
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/backing-up-the-keystore/index.html b/references/Lightning CLI/backing-up-the-keystore/index.html index 8138543ec..c624b7376 100644 --- a/references/Lightning CLI/backing-up-the-keystore/index.html +++ b/references/Lightning CLI/backing-up-the-keystore/index.html @@ -13,7 +13,7 @@ - + @@ -56,6 +56,6 @@

Higher secur 
tar -xf keystore.tar -C $HOME/tar_keystore_extract

Locate the extracted files in $HOME/tar_keystore_extract, which should look like $HOME/tar_keystore/home/<USERNAME>/.lightning/keystore

For a more in depth or step-by-step instructions read the guide managing the keystore.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/error-building-on-arm64/index.html b/references/Lightning CLI/error-building-on-arm64/index.html index fd0c911e1..1b87a035d 100644 --- a/references/Lightning CLI/error-building-on-arm64/index.html +++ b/references/Lightning CLI/error-building-on-arm64/index.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@ 
~/fleek-network/lightning/target/release/lightning-node help

To find the help output:

Usage: lightning-node [OPTIONS] <COMMAND>

Commands:
  run           Start the node
  keys          Handle keys
  print-config  Print the loaded configuration
  help          Print this message or the help of the given subcommand(s)

Options:
  -c, --config <CONFIG>      Path to the toml configuration file [default: ~/.lightning/config.toml]
      --with-mock-consensus  Determines that we should be using the mock consensus backend
  -v...                      Increases the level of verbosity (the max level is -vvv)
      --log-location         Print code location on console logs
  -h, --help                 Print help
  -V, --version              Print version
-
Road aka @road
Road aka @roadCommunity memberJoin our community on discord!
+
Road aka @road
Road aka @roadCommunity memberJoin our community on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1/index.html b/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1/index.html index f420ed902..49da9ef09 100644 --- a/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1/index.html +++ b/references/Lightning CLI/error-linking-with-cc-failed-exist-status-1/index.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

Run the installation script​

curl https://get.fleek.network | bash

Alternatively, read the manual installation instructions for more information.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/file-permissions-and-ownership/index.html b/references/Lightning CLI/file-permissions-and-ownership/index.html index c2f388730..8d0f0562a 100644 --- a/references/Lightning CLI/file-permissions-and-ownership/index.html +++ b/references/Lightning CLI/file-permissions-and-ownership/index.html @@ -13,7 +13,7 @@ - + @@ -86,6 +86,6 @@ 

sudo systemctl daemon-reload

Consequently, when a user manages the service via the systemctl, the Lightning CLI process will read the configuration file settings provided above. It includes the location of the user preferences, such as the keystore location amongst others, preventing confusion regardless of root delegation.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/frequently-used-commands-for-native-setup/index.html b/references/Lightning CLI/frequently-used-commands-for-native-setup/index.html index 5651910a6..cb4b99e68 100644 --- a/references/Lightning CLI/frequently-used-commands-for-native-setup/index.html +++ b/references/Lightning CLI/frequently-used-commands-for-native-setup/index.html @@ -13,7 +13,7 @@ - + @@ -53,6 +53,6 @@

Standard out 
tail -f /var/log/lightning/output.log

Standard error​

tail -f /var/log/lightning/diagnostic.log
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/keys-not-found/index.html b/references/Lightning CLI/keys-not-found/index.html index dc79846f1..98857ac55 100644 --- a/references/Lightning CLI/keys-not-found/index.html +++ b/references/Lightning CLI/keys-not-found/index.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@ 
thread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
thread 'main' panicked at 'Node key does not exist. Use CLI to generate keys.', core/node/src/testnet_sync.rs:126:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

If you haven't deleted the keystore and can locate it, it's due to how the service is being run. As a user can delegate (sudo) the execution of the process to root, the location of the keystore differs on runtime.

To learn more about how file permissions and ownership work, you're advised to read the reference document here.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/node-secret-key-does-not-exist/index.html b/references/Lightning CLI/node-secret-key-does-not-exist/index.html index 8af6515c1..1bfbd5e87 100644 --- a/references/Lightning CLI/node-secret-key-does-not-exist/index.html +++ b/references/Lightning CLI/node-secret-key-does-not-exist/index.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

Edit the ~/.lightning/config.toml to include the full location for the PEM files. For example, let's say that it's located under /home/skywalker that'd look like:

[signer]
consensus_key_path = "/home/skywalker/.lightning/keystore/consensus.pem"
node_key_path = "/home/skywalker/.lightning/keystore/node.pem"

To learn more about how file permissions and ownership work, you're advised to read the reference document here.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/permission-denied-os-error-13/index.html b/references/Lightning CLI/permission-denied-os-error-13/index.html index 39dd6c077..8ec06eb68 100644 --- a/references/Lightning CLI/permission-denied-os-error-13/index.html +++ b/references/Lightning CLI/permission-denied-os-error-13/index.html @@ -13,7 +13,7 @@ - + @@ -40,6 +40,6 @@

Override

In short, it requires you to include a Environment= value of TMPDIR=/var/tmp as follows:

[Service]
...
StandardOutput=append:/var/log/lightning/output.log
StandardError=append:/var/log/lightning/diagnostic.log
Environment=TMPDIR=/var/tmp
attention

The /etc/systemd/system/lightning.service service unit file presented here is a shorter version for simplicity. Do not replace your service unit file with the shorter content version presented here.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/restore-the-keystore/index.html b/references/Lightning CLI/restore-the-keystore/index.html index be8f770a1..fed02ff3a 100644 --- a/references/Lightning CLI/restore-the-keystore/index.html +++ b/references/Lightning CLI/restore-the-keystore/index.html @@ -13,7 +13,7 @@ - + @@ -71,6 +71,6 @@

Resto
tip

Remember to replace the <YOUR-USERNAME> with the correct username for the setup. For example, if you have installed the Fleek Network with the username lgtn that would be /home/lgtn/.lightning/keystore.

Once moved, remember to start the service, you can learn how to manage the service by reading the section Systemd Service.

For a more in depth or step-by-step instructions read the guide managing the keystore.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/uninstall-lightning-node/index.html b/references/Lightning CLI/uninstall-lightning-node/index.html index 486b3ec99..59bbee5b5 100644 --- a/references/Lightning CLI/uninstall-lightning-node/index.html +++ b/references/Lightning CLI/uninstall-lightning-node/index.html @@ -13,7 +13,7 @@ - + @@ -50,6 +50,6 @@

Uninstall Cargo and Rust​

To uninstall rustc, rustup and cargo run the following command:

rustup self uninstall
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Lightning CLI/update-cli-from-source-code/index.html b/references/Lightning CLI/update-cli-from-source-code/index.html index bf37ce003..bc5b2d389 100644 --- a/references/Lightning CLI/update-cli-from-source-code/index.html +++ b/references/Lightning CLI/update-cli-from-source-code/index.html @@ -13,7 +13,7 @@ - + @@ -107,6 +107,6 @@

Health checku 
curl -w "\p" localhost:4230/health

If successful, you should get the response running and staked, as follows:

running and staked
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Systemd/service-keeps-running-after-shutdown/index.html b/references/Systemd/service-keeps-running-after-shutdown/index.html index 745d0631c..2f8580551 100644 --- a/references/Systemd/service-keeps-running-after-shutdown/index.html +++ b/references/Systemd/service-keeps-running-after-shutdown/index.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Kil

A Systemd service is managed by Systemctl, to start, stop, to get status or restart. The service controls the Lightning CLI service, that for our convenience named as lgtn–short for lightning. If you haven't followed the recommended settings and have a custom set up, you need to use the custom details you have defined.

To force stop the service lgtn execute the command:

sudo killall -9 lgtn
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Systemd/shutting-down-persistance/index.html b/references/Systemd/shutting-down-persistance/index.html index b3e69468e..b679c4b56 100644 --- a/references/Systemd/shutting-down-persistance/index.html +++ b/references/Systemd/shutting-down-persistance/index.html @@ -13,7 +13,7 @@ - + @@ -40,6 +40,6 @@ 
2023-09-12 13:53:51 | WARN  | lightning_consensus::consensus - core/consensus/src/consensus.rs:373 - ##################
2023-09-12 13:53:51 | WARN  | lightning_consensus::consensus - core/consensus/src/consensus.rs:374 - ********************************

Alternatively, you can watch the diagnostic.log

tail -f /var/log/lightning/diagnostic.log
-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/Systemd/user-service/index.html b/references/Systemd/user-service/index.html index 972a32591..068b1d67d 100644 --- a/references/Systemd/user-service/index.html +++ b/references/Systemd/user-service/index.html @@ -13,7 +13,7 @@ - + @@ -63,6 +63,6 @@

Problem st

For example, if we check the $XDG_RUNTIME_DIR in a DigitalOcean box, we get the following output:

/run/user/0

For this reason and to provide support for a wider audience of users and systems, we've stuck to sudo to execute the service, but this should not be a requirement and is not recommended.

-
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
+
Helder Oliveira
Helder OliveiraSoftware Developer + DXGot questions? Find us on discord!
\ No newline at end of file diff --git a/references/index.html b/references/index.html index bb66261db..7b7d50c93 100644 --- a/references/index.html +++ b/references/index.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

The references provide concise instructions to interface with the system, broken down into commands or small pieces for quick reference.

It differs from Guides which is more descriptive or verbose when providing instructions and how-to's.

-

To start, find references by consulting the available categories to locate the appropriate content on the sidebar. Our references are also available as a result when using the search feature located at the very top of the documentation site.

+

To start, find references by consulting the available categories to locate the appropriate content on the sidebar. Our references are also available as a result when using the search feature located at the very top of the documentation site.

\ No newline at end of file diff --git a/references/tags/backup/index.html b/references/tags/backup/index.html index fd80d47a2..5463c1e32 100644 --- a/references/tags/backup/index.html +++ b/references/tags/backup/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/build/index.html b/references/tags/build/index.html index 4c80c6d46..145922504 100644 --- a/references/tags/build/index.html +++ b/references/tags/build/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/clean/index.html b/references/tags/clean/index.html index 0647e31f8..c9b18b261 100644 --- a/references/tags/clean/index.html +++ b/references/tags/clean/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/clear/index.html b/references/tags/clear/index.html index 811c5c01e..3250ee4d8 100644 --- a/references/tags/clear/index.html +++ b/references/tags/clear/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/cli/index.html b/references/tags/cli/index.html index 2b8741caf..a562e09c6 100644 --- a/references/tags/cli/index.html +++ b/references/tags/cli/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/commands/index.html b/references/tags/commands/index.html index 854cc3407..d76a677ff 100644 --- a/references/tags/commands/index.html +++ b/references/tags/commands/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/container/index.html b/references/tags/container/index.html index 45f60e1e5..13518dd2d 100644 --- a/references/tags/container/index.html +++ b/references/tags/container/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/delete/index.html b/references/tags/delete/index.html index b3ae40111..3e56e4b05 100644 --- a/references/tags/delete/index.html +++ b/references/tags/delete/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/docker/index.html b/references/tags/docker/index.html index 55e28c254..4af883414 100644 --- a/references/tags/docker/index.html +++ b/references/tags/docker/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/file-permissions/index.html b/references/tags/file-permissions/index.html index b38991721..a13746e23 100644 --- a/references/tags/file-permissions/index.html +++ b/references/tags/file-permissions/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/fix/index.html b/references/tags/fix/index.html index 1c218b26f..009882437 100644 --- a/references/tags/fix/index.html +++ b/references/tags/fix/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/frozen/index.html b/references/tags/frozen/index.html index 962de64b2..493626cea 100644 --- a/references/tags/frozen/index.html +++ b/references/tags/frozen/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/help/index.html b/references/tags/help/index.html index d61d8c169..7a2a320b0 100644 --- a/references/tags/help/index.html +++ b/references/tags/help/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/idle/index.html b/references/tags/idle/index.html index 8816ee994..ec17b62d2 100644 --- a/references/tags/idle/index.html +++ b/references/tags/idle/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/image/index.html b/references/tags/image/index.html index 06c8dfc30..e2c1720ab 100644 --- a/references/tags/image/index.html +++ b/references/tags/image/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/index.html b/references/tags/index.html index a8c3d4cb2..bb6049e95 100644 --- a/references/tags/index.html +++ b/references/tags/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/keystore/index.html b/references/tags/keystore/index.html index b99e732e1..a5be5791c 100644 --- a/references/tags/keystore/index.html +++ b/references/tags/keystore/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/lightning/index.html b/references/tags/lightning/index.html index 923d8d54a..798b1d756 100644 --- a/references/tags/lightning/index.html +++ b/references/tags/lightning/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/lost-keys/index.html b/references/tags/lost-keys/index.html index 9ac5a51cd..cd361ec7d 100644 --- a/references/tags/lost-keys/index.html +++ b/references/tags/lost-keys/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/ownership/index.html b/references/tags/ownership/index.html index 6194ee1dc..a2c04e01b 100644 --- a/references/tags/ownership/index.html +++ b/references/tags/ownership/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/permissions/index.html b/references/tags/permissions/index.html index 3754285e5..18362b826 100644 --- a/references/tags/permissions/index.html +++ b/references/tags/permissions/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/pkill/index.html b/references/tags/pkill/index.html index 82a48dee9..7496f32e3 100644 --- a/references/tags/pkill/index.html +++ b/references/tags/pkill/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/process/index.html b/references/tags/process/index.html index ca2d0c854..e30161098 100644 --- a/references/tags/process/index.html +++ b/references/tags/process/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/reference/index.html b/references/tags/reference/index.html index 3561658c8..7cc3fa2f0 100644 --- a/references/tags/reference/index.html +++ b/references/tags/reference/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/references/index.html b/references/tags/references/index.html index 708c898a7..6be0fa8da 100644 --- a/references/tags/references/index.html +++ b/references/tags/references/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/remove/index.html b/references/tags/remove/index.html index 600a75bfc..10fa937c4 100644 --- a/references/tags/remove/index.html +++ b/references/tags/remove/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/restore/index.html b/references/tags/restore/index.html index f645a84ca..4545a914e 100644 --- a/references/tags/restore/index.html +++ b/references/tags/restore/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/root/index.html b/references/tags/root/index.html index 2d18ce01c..69c81b459 100644 --- a/references/tags/root/index.html +++ b/references/tags/root/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/service-error/index.html b/references/tags/service-error/index.html index 6a07fdd92..69aedf882 100644 --- a/references/tags/service-error/index.html +++ b/references/tags/service-error/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/shutdown/index.html b/references/tags/shutdown/index.html index 14e82b9fb..f6733de7b 100644 --- a/references/tags/shutdown/index.html +++ b/references/tags/shutdown/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/sudoer/index.html b/references/tags/sudoer/index.html index 4d0872452..639eb353b 100644 --- a/references/tags/sudoer/index.html +++ b/references/tags/sudoer/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/systemctl/index.html b/references/tags/systemctl/index.html index 4d176c4a3..0160b2c1e 100644 --- a/references/tags/systemctl/index.html +++ b/references/tags/systemctl/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/systemd/index.html b/references/tags/systemd/index.html index 3485a2751..6139804ad 100644 --- a/references/tags/systemd/index.html +++ b/references/tags/systemd/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/uninstall/index.html b/references/tags/uninstall/index.html index ee4437af8..08b2eda1f 100644 --- a/references/tags/uninstall/index.html +++ b/references/tags/uninstall/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/unit/index.html b/references/tags/unit/index.html index 093e0c2ca..e2947a4fc 100644 --- a/references/tags/unit/index.html +++ b/references/tags/unit/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/update/index.html b/references/tags/update/index.html index 3a9195353..4ce016ec2 100644 --- a/references/tags/update/index.html +++ b/references/tags/update/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/upgrade/index.html b/references/tags/upgrade/index.html index d6d31ce85..b7bddd988 100644 --- a/references/tags/upgrade/index.html +++ b/references/tags/upgrade/index.html @@ -13,7 +13,7 @@ - + diff --git a/references/tags/user-service/index.html b/references/tags/user-service/index.html index 5f88ce468..8b79246c5 100644 --- a/references/tags/user-service/index.html +++ b/references/tags/user-service/index.html @@ -13,7 +13,7 @@ - + diff --git a/search/index.html b/search/index.html index faf6c2b61..993bdb1a8 100644 --- a/search/index.html +++ b/search/index.html @@ -13,7 +13,7 @@ - +