Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Jcofles/Proyecto-web/llms.txt

Use this file to discover all available pages before exploring further.

This page lists every environment variable UniMaps reads at runtime. Before starting the backend for the first time you must copy .env.example to .env inside the Clase1/ directory and fill in each value. Variables left at their example placeholders will cause the application to fail or behave unexpectedly.

App settings

These variables control the core Laravel runtime behavior.
VariableRequiredExample valueDescription
APP_NAMEYesUniMapsDisplay name used in emails and the application shell.
APP_ENVYesproductionRuntime environment. Use local for development, production for live deployments.
APP_KEYYesbase64:...Encryption key for sessions, cookies, and encrypted values.
APP_DEBUGYesfalseSet to false in production to suppress stack traces in HTTP responses.
APP_URLYeshttps://backend.up.railway.appPublic URL of the Laravel backend. Used to build absolute links.
APP_FRONTEND_URLYeshttps://frontend.up.railway.appPublic URL of the Vue frontend. Used in email verification links and CORS.
APP_LOCALENoenDefault locale for translated strings.
APP_KEY must never be left empty or reused between environments. Generate a unique value locally and paste it into your deployment platform’s environment variable UI.
cd Clase1
php artisan key:generate --show
Copy the output (starting with base64:) and set it as APP_KEY.

Session and authentication

VariableRequiredExample valueDescription
SESSION_DRIVERNodatabaseStorage backend for sessions. database is recommended for multi-instance deployments.
SESSION_LIFETIMENo120How long (in minutes) an idle session remains valid.
SESSION_DOMAINYes (prod).up.railway.appDomain shared by backend and frontend so the session cookie is accessible to both.
SANCTUM_STATEFUL_DOMAINSYes (prod)frontend.up.railway.appComma-separated list of frontend hostnames that may send cookie-authenticated requests.
BCRYPT_ROUNDSNo12Cost factor for bcrypt password hashing. Higher values are slower but more secure.

Database

See Database Setup and Schema for the full reference. The variables below are the ones you configure here in .env.
VariableRequiredExample valueDescription
DB_CONNECTIONYesmysqlDatabase driver. UniMaps requires mysql.
DB_HOSTYesmysql.railway.internalHostname of the MySQL server.
DB_PORTYes3306TCP port the MySQL server listens on.
DB_DATABASEYesunimapsName of the database schema to use.
DB_USERNAMEYesunimaps_userMySQL user with full privileges on DB_DATABASE.
DB_PASSWORDYes(secret)Password for DB_USERNAME.

Mail / email

See Configure Email for UniMaps Notifications for the full provider setup guide.
VariableRequiredExample valueDescription
MAIL_MAILERYessmtpTransport driver. Use smtp for Gmail or any SMTP relay.
MAIL_HOSTYessmtp.gmail.comSMTP server hostname.
MAIL_PORTYes587SMTP server port. Port 587 with TLS is standard.
MAIL_USERNAMEYesno-reply@example.comSMTP authentication username (usually the sender address).
MAIL_PASSWORDYes(secret)SMTP password or App Password. Never use your regular account password.
MAIL_ENCRYPTIONYestlsTransport security. Use tls for port 587 or ssl for port 465.
MAIL_FROM_ADDRESSYesno-reply@example.comThe From address shown in all outgoing emails.
MAIL_FROM_NAMEYesITFIP MapsThe sender name shown in all outgoing emails.
BREVO_API_KEYConditional(secret)Required only when using Brevo (Sendinblue) as the email provider instead of SMTP.

Frontend

These variables are read by Vite at build time inside the itfip-map/ frontend project.
VariableRequiredExample valueDescription
VITE_API_URLYeshttps://backend.up.railway.app/apiFull URL of the backend API, including the /api path prefix. The Vue app appends individual endpoint paths to this base.
VITE_API_URL is embedded into the compiled JavaScript bundle at build time. If you change the backend URL after building, you must rebuild the frontend for the change to take effect.
Railway provides a dedicated “Variables” tab for each service where you can add, edit, and redeploy environment variables without touching any files. Changes take effect on the next deploy. Shared variables across services (for example, SESSION_DOMAIN) can be set once in a shared environment and referenced in both the backend and frontend services.

Build docs developers (and LLMs) love