Marmotteio Save Abandoned

Marmotte is an open-source IT asset management system built with Laravel, PHP. It's designed to help you keep track of all your IT resources in your business environment.

Table of Contents

• Quick deploy
• Features
• Running Marmotte with Docker
• Running Marmotte with Docker Compose
• Running in dev-mode with Laravel Sail
• Tech Stack
• Database Compatibility
• Frequently Asked Questions
  • General
  • Features and Support
  • Bugs and Contributions
  • Troubleshooting
• Roadmap
• Contributing
• Security
• Support
• Authors
• License
• Acknowledgments

Quick deploy

 

Features

Marmotte offers the following features:

• Asset Tracking: Keep an inventory of all your IT assets and track their status in real time.
• User-Friendly Interface: Navigate through the system with an intuitive and user-friendly interface.
• Reports and Analytics: Generate detailed reports about your IT assets for better decision-making.
• Secure: Security is a top priority. Marmotte is designed with robust security measures to protect your data.

Running Marmotte with Docker

Using Docker is one of the quickest and most efficient ways to get Marmotte up and running, irrespective of the platform you're on. Docker encapsulates the application within a container, ensuring it has all the dependencies it needs to run. This means you don't have to worry about installing any additional software or libraries; Docker handles it all for you.

Firstly, if you haven't already, you need to install Docker. Detailed instructions for various platforms can be found on the official Docker documentation.

Once Docker is installed, you can deploy Marmotte with just one command:

docker run -p 5959:8000 \
    --name marmotteio \
    -e APP_NAME=Marmotte.io \
    -e APP_ENV=local \
    -e APP_DEBUG=true \
    -e APP_URL=http://0.0.0.0:5959 \
    -e ASSET_URL=http://0.0.0.0:5959 \
    -e APP_KEY=base64:RVvW9+2jO9MpuTDyxmIO45Z9t7BY0VWxgDImBNmhFwA= \
    -e DB_CONNECTION=sqlite \
    -e DB_DATABASE=/app/marmotte.sqlite \
    -e DB_FOREIGN_KEYS=true \
    -v marmotteio:/app \
    marmotteio/marmotteio:latest

After the Docker container is running, you can open your favorite browser and head over to:

http://localhost:5959

Default email is [email protected], and default password is marmotte.io.

And that's it! You now have Marmotte running in a Docker container on your machine. This method is especially useful for quick deployments, testing, or even for production scenarios if configured properly.

Note: Do remember to adjust the Docker command as per your requirements, particularly if you need to pass in environment variables, link to databases, or make any other configuration changes.

Viewing Logs and Managing the Docker Container

Once Marmotte is running within a Docker container, there might be scenarios where you need to view logs in real-time, or you might want to stop the container. Here's how you can do that:

To tail the logs in real-time for your running container, use the following command:

docker logs -f marmotteio

To stop the Marmotte Docker container:

docker stop marmotteio

Running Marmotte with Docker Compose

Docker Compose offers a convenient method to deploy applications like Marmotte, which might consist of several containers that need to interact with each other. The docker-compose.yml file in the Marmotte repository defines how these containers should be built and run.

Prerequisites

• Docker and Docker Compose must be installed on your machine. These tools are essential for running containers and managing multi-container applications.

Detailed Steps

1. Clone the Marmotte Repository: First, clone the Marmotte repository. This repository contains the necessary source code and configuration files, including docker-compose.yml. In your terminal, use the git clone command followed by the repository's URL. This step downloads the latest version of the Marmotte code to your local machine.

2. Navigate to the Repository Directory: Change your current directory in the terminal to the one where you cloned the Marmotte repository. This directory contains the Docker Compose file that you will use in the next steps.

3. Inspect the Docker Compose File: Before proceeding, take a moment to open and review the docker-compose.yml file. This file is a YAML file that specifies how Docker should run and manage the service containers that make up your Marmotte application. Check for things like the defined services, the ports that are exposed, and any volume mappings. Understanding this file helps you grasp how the application components are orchestrated.

4. Run Docker Compose: Execute the following command in the terminal:

   docker-compose up

This command tells Docker Compose to start the services defined in your docker-compose.yml file. On the first run, Docker will download the necessary images and build the containers, which might take some time. Once the process is complete, your Marmotte application will be running inside these containers.

5. Access Marmotte: Open a web browser and go to http://localhost:5959 to access the Marmotte application. This URL connects you to the local instance of Marmotte running in your Docker containers.

Additional Information and Tips

• The docker-compose up command may take longer during the first execution due to the downloading and building of Docker images. Subsequent runs will be faster as Docker caches these builds.
• Regularly check the Marmotte repository for updates, especially for changes in the docker-compose.yml file, as these might include critical updates or feature additions.
• If you encounter any issues or need to make advanced configurations, refer to the Marmotte documentation or seek community support.

By following these detailed steps, you can successfully run and manage the Marmotte application using Docker Compose.

Running in dev-mode with Laravel Sail

Marmotte utilizes Docker for easy setup and deployment via Laravel Sail, a light-weight command-line interface for interacting with Laravel's default Docker development environment. To get started, ensure you have Docker and Docker Compose installed on your system.

Before installing Marmotte, please make sure that no other web servers or databases are running on your local machine.

1. Clone this repository to your local machine.

   git clone https://github.com/marmotteio/marmotteio.git
   

2. Navigate to the project directory.

   cd marmotteio
   

3. Start the Docker environment.

   Laravel Sail provides a convenient method for starting and managing the Docker services defined by your application's docker-compose.dev.yml file. Rename it to docker-compose.yml, then start the Docker environment using the sail up command:

   ./vendor/bin/sail up
   

   The first time you run the Sail up command, Sail's Docker images will be built on your machine. This could take several minutes. Subsequent attempts to start Sail will be much faster.

   Sail publishes various services on standard ports on your system. For example, Laravel is accessible on port 80. Therefore, you may access the project in your web browser at: http://localhost.

4. Visit localhost in your browser to access Marmotte.

   After the Docker containers are running, navigate to http://localhost in your web browser. You should see the Marmotte application running.

Tech Stack

Marmotte is built with the following technologies:

• Laravel 10: A robust framework for web artisans.
• PHP 8.3: A popular general-purpose scripting language that is especially suited to web development.

Additional PHP packages used in Marmotte:

• flowframe/laravel-trend: Provides trendline functionality in Laravel.
• guzzlehttp/guzzle: A PHP HTTP client and framework for building RESTful web service clients.
• laravel/sanctum: Laravel Sanctum provides a featherweight authentication system for SPAs and simple APIs.
• laravel/tinker: A REPL for Laravel.
• league/flysystem-aws-s3-v3: An AWS S3 adapter for Flysystem.
• livewire/livewire: A full-stack framework for Laravel that makes building dynamic interfaces simple, without leaving the comfort of Laravel.
• predis/predis: A flexible and feature-complete Redis client for PHP.
• rackbeat/laravel-ui-avatars: Generate avatars on the fly in Laravel.
• spatie/laravel-backup: A package to backup your Laravel app.
• spatie/laravel-discord-alerts: Send alerts to Discord from a Laravel app.

Development dependencies include tools such as PHPUnit for testing, Laravel Sail for managing the Docker environment, and Faker for generating fake data.

Please refer to the composer.json file for the full list of dependencies.

Database Compatibility

Marmotte is compatible with multiple database systems to cater to various deployment needs. Out of the box, Marmotte supports:

• SQLite: A lightweight, serverless database, ideal for development, testing, or small deployments. With SQLite, the database is stored as a file, making it easy to set up without any additional database server configuration.

• MySQL: One of the most popular open-source relational database systems. It's well-suited for production environments, offering robust performance, reliability, and a wide range of features.

• PostgreSQL (pgsql): An advanced open-source database system known for its extensibility, standards compliance, and performance. PostgreSQL is a great choice for complex applications that require advanced data types and powerful query capabilities.

When deploying Marmotte, you can choose the database that aligns best with your requirements and infrastructure. Configuration details, such as connection strings and environment variables, can be adjusted accordingly in the application settings.

Frequently Asked Questions

General

Q: Is Marmotte really free? A: Yes, Marmotte is an open-source project and is free to use. However, we also offer paid support and additional features for our paying customers.

Q: What technologies does Marmotte use? A: Marmotte is built with Laravel, PHP, Redis, and Meilisearch. You can find more details in the Tech Stack section.

Features and Support

Q: I have a feature request. How can I suggest it? A: We welcome feature requests! You can suggest new features by opening an issue on our GitHub repository. Please ensure that the feature hasn't been requested already before creating a new issue.

Q: I need help with Marmotte. Where can I ask questions? A: We have a few ways you can get help. Check out our documentation, join our Discord community, or open an issue on our GitHub repository. If you're a paying customer, you can contact us directly at [email protected].

Q: What kind of support do you provide for paying customers? A: Paying customers have direct access to our support team at [email protected]. They also have access to premium features not available in the free version.

Bugs and Contributions

Q: I found a bug. Where can I report it? A: You can report bugs by opening an issue on our GitHub repository. Please ensure that the bug hasn't been reported already before creating a new issue.

Q: I want to contribute to Marmotte. How can I do that? A: We welcome all contributions! You can read our CONTRIBUTING.md file for details on our code of conduct and the process for submitting pull requests.

Q: How can I stay updated about new releases and changes? A: You can keep track of updates by following our GitHub repository. We also publish updates in our Discord community.

Troubleshooting

Experiencing issues with Marmotte? We're here to help!

Before reaching out to us, we recommend that you first check our TROUBLESHOOTING.md file. This document contains solutions to some common problems encountered by Marmotte users.

If your issue isn't covered in the troubleshooting guide, you can:

• Check if there's already an answer to your question in the Frequently Asked Questions section.
• Search for your issue in our GitHub repository's issues to see if it has been reported or solved already.
• Join our Discord community and ask for help.
• Contact us directly at [email protected] if you're a paying customer.

Remember, the more details you provide about your problem, the easier it will be for us to help you.

Roadmap

We are constantly working to improve Marmotte and expand its capabilities. Here are some features we plan to implement in the future:

• Asset Lifecycle Management: Track the complete lifecycle of an asset from procurement to retirement.
• Integrations: Integrate with other systems to provide a seamless IT asset management experience.
• Enhanced Security: Implement advanced security features to further protect your data.

Detailed roadmap can be found in the ROADMAP.md file.

Contributing

Contributions to Marmotte are always welcome! Whether it's improving documentation, reporting bugs, or writing code, we appreciate all forms of help.

Please read our CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Security

Security is of the utmost importance to us and we take it very seriously. If you discover a security vulnerability within Marmotte, we encourage you to report it to us right away. We appreciate your efforts to responsibly disclose your findings.

Please DO NOT create a GitHub issue for a security vulnerability. Instead, send an email directly to our security team at [email protected]. This will help us to assess the issue quickly and respond as necessary to prevent any potential exploits.

Upon receiving a security vulnerability, we will:

• Confirm the receipt of your vulnerability report
• Assess the impact and severity of the issue
• Work towards patching the vulnerability promptly
• Notify all users about the issue and the recommended action they should take

To learn more about the process, please refer to our SECURITY.md file, where we outline our security policy and provide more details about how we handle security vulnerabilities.

We are committed to working with security researchers and the open-source community to make Marmotte secure for everyone. We thank you in advance for your contribution.

Support

If you encounter any problems or have questions about Marmotte, we are here to help. Here are a few ways you can get support:

1. Documentation: We have extensive documentation that covers a wide range of topics about how to use Marmotte. It's often the fastest way to get the answers to your questions.

2. Issue Tracker: If you've found a bug or want to suggest a new feature, please use our GitHub issue tracker. Before submitting a new issue, please make sure to check if a similar issue hasn't been reported already.

3. Discord Community: We have a lively Discord community where you can ask questions, share your experiences, and connect with other Marmotte users. Join us on Discord.

4. Direct Support: If you're a paying customer and need direct assistance or have a specific request, you can contact us at [email protected]. We aim to respond to all queries within 48 hours. Please note that this support channel is reserved for our paying customers.

When asking for help, remember to provide as much context as possible. The more details you provide, the easier it will be for us or the community to assist you.

Marmotte is an open-source project, and while we strive to provide the best support possible, please note that response times may vary.

Authors

See the list of contributors who participated in this project. This includes people who have submitted pull requests or contributed in other ways. You can find a detailed breakdown in the CONTRIBUTORS.md file.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This license permits you to use, modify, and distribute the project, but with the critical requirement that source code of any modifications or derivative works MUST BE PROVIDED to the recipients under the same license.

Importantly, if your version of this project is network-accessible, the AGPL stipulates that users who interact with it remotely via a computer network must be given access to its source code. This key requirement ensures that all users, even those who interact with the software over a network, can see the code and modify it for their own needs.

For full details on the rights, obligations, and limitations, please refer to the LICENSE file in this repository, or check the official text of the GNU AGPL v3.0.

Acknowledgments

Thanks to all the contributors who have helped to build Marmotte, making IT asset management easier for everyone.

For more information on Marmotte, please visit our website.