Editing Config Files: Difference between revisions

From AllStarLink Wiki
Jump to navigation Jump to search
imported>Wd6awp
No edit summary
No edit summary
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
To modify your node beyond the basic settings of what nodesetup.sh can do, you'll need to manually edit the config files.
{{Warning|user-guide/menu/#expert-configuration}}
 
To modify your node beyond the basic settings of nodesetup.sh, you'll need to manually edit the config files. Of course, you'll need to know the user ID and password of your AllStarLink server. You also want to understand the [[Structure of Config Files|Structure of Config Files]] before you start.


=Linux CLI Editors=
=Linux CLI Editors=
For quick and simple changes the built-in Linux editors are the way to go.  
For quick and simple changes the built-in Linux editors are the way to go.  
* [http://www.lagmonster.org/docs/vi.html vi] is pretty much the default editor on most linux distros. Learn it, love it.
* [http://www.lagmonster.org/docs/vi.html vi] is pretty much the default editor on most linux distros. Learn it, love it.
** Update vi to fix cursor movement (apt-get install vim).
* [https://www.vim.org/ vim] is an improved version of vi with plugin support and many more features. To install:
: <code>apt-get -y install vim</code>
* [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ nano] is easier to learn and preferred by many.
* [https://www.howtogeek.com/howto/42980/the-beginners-guide-to-nano-the-linux-command-line-text-editor/ nano] is easier to learn and preferred by many.


Line 11: Line 14:


For Windows:
For Windows:
* [https://winscp.net/ Winscp] is a popular file transfer and editor client.
* [https://winscp.net/ WinSCP] is a popular file transfer and editor client. See [https://community.allstarlink.org/t/help-winscp-permission-denied-error-code-3-error-message-from-server-permission-denied/16267/4?u=wd6awp | Using WinSCP] Topic on Community.
* [http://www.putty.org Putty] is '''the''' SSH and Telnet client.
* [http://www.putty.org Putty] is not an editor but you'll need it. It is '''the''' SSH and Telnet client.  


For Mac:
For Mac:
* [https://panic.com/transmit/ Transmit] or [https://cyberduck.io CyberDuck] file transfer client.
* [https://panic.com/transmit/ Transmit] or [https://cyberduck.io CyberDuck] file transfer client.
* [https://macromates.com Text Mate] or [https://www.sublimetext.com Sublime] Editor.
* [https://macromates.com Text Mate] or [https://www.sublimetext.com Sublime] Editor.
* [https://github.com/macvim-dev/macvim MacVim] is a GUI based version of VIM


=Location of Config Files=
=Location of Config Files=
Nearly all of the files you'll need to edit are in /etc/asterisk
Nearly all of the files you'll need to edit are in /etc/asterisk
=Warnings=
There are other ftp/sftp gui's like filezilla. To use this program for example, it does not have a built-in editor. If you install this on a windows machine and use a windows editor, know that the way windows systems handle text files is different. Mainly with they way a linefeed and carrage-return linefeed is inserted into the file. This is something you will not visually see unless you feed the file into something like Notepad++ and use the option 'reveal all codes'.
While 'most times' you will not notice any issues while only editing .conf files, do not use windows editors on system files such as crontab etc. You likely will not like the results. However, there are windows based editors that will handle this correctly or can if is set to handle it correctly. Investigate before you find yourself in need of help as you will never see anything wrong with the file.
Any internal editor will be just fine and WinSCP is a exelent choice. If using Filezilla on a linux system, choose 'KATE' or similar to edit your files from within the program and all will be fine.
[[Category:How to]]
[[Category:Node Configuration]]

Latest revision as of 21:27, 29 June 2024

Legacy Version - This page is about a legacy version of AllStarLink. See https://allstarlink.github.io/user-guide/menu/#expert-configuration

To modify your node beyond the basic settings of nodesetup.sh, you'll need to manually edit the config files. Of course, you'll need to know the user ID and password of your AllStarLink server. You also want to understand the Structure of Config Files before you start.

Linux CLI Editors

For quick and simple changes the built-in Linux editors are the way to go.

  • vi is pretty much the default editor on most linux distros. Learn it, love it.
  • vim is an improved version of vi with plugin support and many more features. To install:
apt-get -y install vim
  • nano is easier to learn and preferred by many.

GUI Editors

Many folks prefer a GUI editor and file transfer client over the Linux vi and nano editors. If you need to do a lot of copy and paste these are much easier. Here are some of the many clients out there.

For Windows:

  • WinSCP is a popular file transfer and editor client. See | Using WinSCP Topic on Community.
  • Putty is not an editor but you'll need it. It is the SSH and Telnet client.

For Mac:

Location of Config Files

Nearly all of the files you'll need to edit are in /etc/asterisk

Warnings

There are other ftp/sftp gui's like filezilla. To use this program for example, it does not have a built-in editor. If you install this on a windows machine and use a windows editor, know that the way windows systems handle text files is different. Mainly with they way a linefeed and carrage-return linefeed is inserted into the file. This is something you will not visually see unless you feed the file into something like Notepad++ and use the option 'reveal all codes'.

While 'most times' you will not notice any issues while only editing .conf files, do not use windows editors on system files such as crontab etc. You likely will not like the results. However, there are windows based editors that will handle this correctly or can if is set to handle it correctly. Investigate before you find yourself in need of help as you will never see anything wrong with the file. Any internal editor will be just fine and WinSCP is a exelent choice. If using Filezilla on a linux system, choose 'KATE' or similar to edit your files from within the program and all will be fine.