This is the repo for the Uptane Website, an open-source framework that ensures the security of software updates for vehicles, particularly those receiving software over the air.
Uptane is an open-source framework that ensures the security of software updates for vehicles, particularly those receiving software over the air. Given the increasing complexity of modern vehicles, which often rely on numerous software components, ensuring that these updates are secure and tamper-proof is crucial.
Uptane addresses potential vulnerabilities and threats that can arise during the software update process. Read more here
- Fork the Repository:
- Go to the Uptane repository on Github.
- Click on the "Fork" button at the top right corner of the page. Wait for a copy of the repository to appear under your account.
- Clone the uptane.github.io repository:
git clone https://github.com/uptane/uptane.github.io - Change to the project directory:
cd uptane.github.io - Install the dependencies:
yarn installIf you do not have Yarn installed, please refer to the Yarn documentation for installation instructions.
-
Once the installation is complete, you can start the development server using either Yarn or npm.
-
To start with Yarn, run:
yarn start
- To start with npm, run:
npm start
-
If the installation went well, the development server will run locally, at
http://localhost:3000. -
You should see your application running locally with any changes you apply.
- Keep Docusaurus and dependencies updated.
- Clear
node_modulesand reinstall dependencies if issues persist.
- Verify
docusaurus.config.jsfor errors. - Check browser console for build errors.
- Temporarily disable plugins to identify conflicts.
- Refer to plugin documentation for known issues.
- Regularly update documentation content.
- Check for and fix broken links.
- Optimize images and minify CSS/JavaScript.
- Enhance site performance for better user experience.
- Test across browsers and devices.
- Ensure mobile-friendly design.
- Review Docusaurus build and server logs.
- Search online forums for solutions.
- Use version control (e.g., Git) for tracking changes.
Always refer to Docusaurus documentation and community resources for specific guidance, and test changes in a staging environment before applying them to production.
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: 🐛 Submit any bugs found or log feature requests for UPTANE. Please await assignment for your submitted issues.
- Submit Pull Requests: 🛠️ submit your PRs addressing the assigned issues.
- Join the Discussions: 💬 Engage in discussions by sharing your insights, providing feedback, or asking any relevant questions.
For more information, please refer to Uptane Contribution guidelines
This work is dual-licensed and distributed under (1) Apache License, Version 2.0 and (1) MIT License. Please
take a look at LICENSE and LICENSE-MIT.
This project is managed by Prof. Justin Cappos and other members of the Secure Systems Lab at NYU.
Uptane was initiated with support from the U.S. Department of Homeland Security grants D15PC00239 and D15PC00302. The views and conclusions contained herein are the authors’ and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Department of Homeland Security (DHS) or the U.S. government.
