Setting up the EA3CV contributions repository

From DXSpider Documentation Wiki
Revision as of 06:58, 9 April 2025 by EA3CV (talk | contribs) (Created page with " = 📘 Installation and Maintenance Guide for the ''contrib/ea3cv'' Repository = == 📍 Purpose == This document provides step-by-step instructions for installing and keeping up to date the ''ea3cv'' repository under:<pre>/home/sysop/spider/contrib/ea3cv</pre>This repository is intended as a reference, backup, or development environment. It does '''not directly affect the DXSpider system''' unless its contents are copied into active directories such as <code>local_cmd...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

📘 Installation and Maintenance Guide for the contrib/ea3cv Repository

📍 Purpose

This document provides step-by-step instructions for installing and keeping up to date the ea3cv repository under:

/home/sysop/spider/contrib/ea3cv

This repository is intended as a reference, backup, or development environment. It does not directly affect the DXSpider system unless its contents are copied into active directories such as local_cmd/.

🧩 1. Initial Installation

▶️ Step 1: Change to the target directory

cd /home/sysop/spider/contrib

▶️ Step 2: Clone the repository

git clone https://github.com/EA3CV/dxspider_info.git ea3cv

This will create the directory:

/home/sysop/spider/contrib/ea3cv/

containing all the contents of the remote GitHub repository.

🔄 2. Updating the Repository

▶️ Manual update

To fetch the latest changes from GitHub at any time:

cd /home/sysop/spider/contrib/ea3cv
git pull

This will update the local copy to the latest available version.

🕒 Optional: Automatic update via crontab

To keep the repository automatically up to date, add a cron job:

  1. Edit the crontab:
nano local_cmd/crontab
  1. Add the following line to update daily at 04:00:
0 4 * * * spawn("cd /home/sysop/spider/contrib/ea3cv; git pull")

This command will:

  • Perform a git pull every day at 04:00.

Note: Avoid making local modifications inside this repository if it is updated automatically via cron, to prevent merge conflicts.

🛠️ 3. Using the Cloned Repository

This repository may contain:

  • Scripts under set/, show/, unset/
  • Configuration examples
  • Utility tools

You may copy files from this repository into production directories, such as:

/home/sysop/spider/local_cmd/

For example:

cp /home/sysop/spider/contrib/ea3cv/set/myscript.pl /home/sysop/spider/local_cmd/set/

✅ Quick Summary

Action Command
Clone the repository git clone https://github.com/EA3CV/dxspider_info.git ea3cv
Manual update cd ea3cv && git pull
Copy script to production cp ea3cv/set/myscript.pl ../local_cmd/set/
Enable auto-update (cron) See the crontab section above

🧠 Notes

  • This repository is ideal for maintaining clean, reusable command scripts and documentation.
  • Custom scripts or local changes should be done outside this directory, typically in local_cmd/.
Retrieved from "https://wiki.dxcluster.org/w/index.php?title=Setting_up_the_EA3CV_contributions_repository&oldid=372"